@backstage/integration 1.20.0 → 2.0.0-next.1

package/dist/index.cjs.js

@@ -11,36 +11,32 @@ var AzureIntegration = require('./azure/AzureIntegration.cjs.js');
 var config$3 = require('./azure/config.cjs.js');
 var core = require('./azure/core.cjs.js');
 var DefaultAzureDevOpsCredentialsProvider = require('./azure/DefaultAzureDevOpsCredentialsProvider.cjs.js');
-var deprecated = require('./azure/deprecated.cjs.js');
-var BitbucketIntegration = require('./bitbucket/BitbucketIntegration.cjs.js');
-var config$4 = require('./bitbucket/config.cjs.js');
-var core$1 = require('./bitbucket/core.cjs.js');
 var BitbucketCloudIntegration = require('./bitbucketCloud/BitbucketCloudIntegration.cjs.js');
-var config$5 = require('./bitbucketCloud/config.cjs.js');
-var core$2 = require('./bitbucketCloud/core.cjs.js');
+var config$4 = require('./bitbucketCloud/config.cjs.js');
+var core$1 = require('./bitbucketCloud/core.cjs.js');
 var BitbucketServerIntegration = require('./bitbucketServer/BitbucketServerIntegration.cjs.js');
-var config$6 = require('./bitbucketServer/config.cjs.js');
-var core$3 = require('./bitbucketServer/core.cjs.js');
+var config$5 = require('./bitbucketServer/config.cjs.js');
+var core$2 = require('./bitbucketServer/core.cjs.js');
 var GerritIntegration = require('./gerrit/GerritIntegration.cjs.js');
-var config$7 = require('./gerrit/config.cjs.js');
-var core$4 = require('./gerrit/core.cjs.js');
+var config$6 = require('./gerrit/config.cjs.js');
+var core$3 = require('./gerrit/core.cjs.js');
 var GiteaIntegration = require('./gitea/GiteaIntegration.cjs.js');
-var core$5 = require('./gitea/core.cjs.js');
-var config$8 = require('./gitea/config.cjs.js');
-var config$9 = require('./github/config.cjs.js');
-var core$6 = require('./github/core.cjs.js');
+var core$4 = require('./gitea/core.cjs.js');
+var config$7 = require('./gitea/config.cjs.js');
+var config$8 = require('./github/config.cjs.js');
+var core$5 = require('./github/core.cjs.js');
 var DefaultGithubCredentialsProvider = require('./github/DefaultGithubCredentialsProvider.cjs.js');
 var SingleInstanceGithubCredentialsProvider = require('./github/SingleInstanceGithubCredentialsProvider.cjs.js');
 var GithubIntegration = require('./github/GithubIntegration.cjs.js');
-var config$a = require('./gitlab/config.cjs.js');
-var core$7 = require('./gitlab/core.cjs.js');
+var config$9 = require('./gitlab/config.cjs.js');
+var core$6 = require('./gitlab/core.cjs.js');
 var GitLabIntegration = require('./gitlab/GitLabIntegration.cjs.js');
 var DefaultGitlabCredentialsProvider = require('./gitlab/DefaultGitlabCredentialsProvider.cjs.js');
-var config$b = require('./googleGcs/config.cjs.js');
+var config$a = require('./googleGcs/config.cjs.js');
 var GoogleGcsIntegration = require('./googleGcs/GoogleGcsIntegration.cjs.js');
 var HarnessIntegration = require('./harness/HarnessIntegration.cjs.js');
-var core$8 = require('./harness/core.cjs.js');
-var config$c = require('./harness/config.cjs.js');
+var core$7 = require('./harness/core.cjs.js');
+var config$b = require('./harness/config.cjs.js');
 var helpers = require('./helpers.cjs.js');
 var ScmIntegrations = require('./ScmIntegrations.cjs.js');
 
@@ -63,77 +59,66 @@ exports.getAzureCommitsUrl = core.getAzureCommitsUrl;
 exports.getAzureDownloadUrl = core.getAzureDownloadUrl;
 exports.getAzureFileFetchUrl = core.getAzureFileFetchUrl;
 exports.DefaultAzureDevOpsCredentialsProvider = DefaultAzureDevOpsCredentialsProvider.DefaultAzureDevOpsCredentialsProvider;
-exports.getAzureRequestOptions = deprecated.getAzureRequestOptions;
-exports.BitbucketIntegration = BitbucketIntegration.BitbucketIntegration;
-exports.readBitbucketIntegrationConfig = config$4.readBitbucketIntegrationConfig;
-exports.readBitbucketIntegrationConfigs = config$4.readBitbucketIntegrationConfigs;
-exports.getBitbucketDefaultBranch = core$1.getBitbucketDefaultBranch;
-exports.getBitbucketDownloadUrl = core$1.getBitbucketDownloadUrl;
-exports.getBitbucketFileFetchUrl = core$1.getBitbucketFileFetchUrl;
-exports.getBitbucketRequestOptions = core$1.getBitbucketRequestOptions;
 exports.BitbucketCloudIntegration = BitbucketCloudIntegration.BitbucketCloudIntegration;
-exports.readBitbucketCloudIntegrationConfig = config$5.readBitbucketCloudIntegrationConfig;
-exports.readBitbucketCloudIntegrationConfigs = config$5.readBitbucketCloudIntegrationConfigs;
-exports.getBitbucketCloudDefaultBranch = core$2.getBitbucketCloudDefaultBranch;
-exports.getBitbucketCloudDownloadUrl = core$2.getBitbucketCloudDownloadUrl;
-exports.getBitbucketCloudFileFetchUrl = core$2.getBitbucketCloudFileFetchUrl;
-exports.getBitbucketCloudOAuthToken = core$2.getBitbucketCloudOAuthToken;
-exports.getBitbucketCloudRequestOptions = core$2.getBitbucketCloudRequestOptions;
+exports.readBitbucketCloudIntegrationConfig = config$4.readBitbucketCloudIntegrationConfig;
+exports.readBitbucketCloudIntegrationConfigs = config$4.readBitbucketCloudIntegrationConfigs;
+exports.getBitbucketCloudDefaultBranch = core$1.getBitbucketCloudDefaultBranch;
+exports.getBitbucketCloudDownloadUrl = core$1.getBitbucketCloudDownloadUrl;
+exports.getBitbucketCloudFileFetchUrl = core$1.getBitbucketCloudFileFetchUrl;
+exports.getBitbucketCloudOAuthToken = core$1.getBitbucketCloudOAuthToken;
+exports.getBitbucketCloudRequestOptions = core$1.getBitbucketCloudRequestOptions;
 exports.BitbucketServerIntegration = BitbucketServerIntegration.BitbucketServerIntegration;
-exports.readBitbucketServerIntegrationConfig = config$6.readBitbucketServerIntegrationConfig;
-exports.readBitbucketServerIntegrationConfigs = config$6.readBitbucketServerIntegrationConfigs;
-exports.getBitbucketServerDefaultBranch = core$3.getBitbucketServerDefaultBranch;
-exports.getBitbucketServerDownloadUrl = core$3.getBitbucketServerDownloadUrl;
-exports.getBitbucketServerFileFetchUrl = core$3.getBitbucketServerFileFetchUrl;
-exports.getBitbucketServerRequestOptions = core$3.getBitbucketServerRequestOptions;
+exports.readBitbucketServerIntegrationConfig = config$5.readBitbucketServerIntegrationConfig;
+exports.readBitbucketServerIntegrationConfigs = config$5.readBitbucketServerIntegrationConfigs;
+exports.getBitbucketServerDefaultBranch = core$2.getBitbucketServerDefaultBranch;
+exports.getBitbucketServerDownloadUrl = core$2.getBitbucketServerDownloadUrl;
+exports.getBitbucketServerFileFetchUrl = core$2.getBitbucketServerFileFetchUrl;
+exports.getBitbucketServerRequestOptions = core$2.getBitbucketServerRequestOptions;
 exports.GerritIntegration = GerritIntegration.GerritIntegration;
-exports.readGerritIntegrationConfig = config$7.readGerritIntegrationConfig;
-exports.readGerritIntegrationConfigs = config$7.readGerritIntegrationConfigs;
-exports.buildGerritGitilesArchiveUrl = core$4.buildGerritGitilesArchiveUrl;
-exports.buildGerritGitilesArchiveUrlFromLocation = core$4.buildGerritGitilesArchiveUrlFromLocation;
-exports.getGerritBranchApiUrl = core$4.getGerritBranchApiUrl;
-exports.getGerritCloneRepoUrl = core$4.getGerritCloneRepoUrl;
-exports.getGerritFileContentsApiUrl = core$4.getGerritFileContentsApiUrl;
-exports.getGerritProjectsApiUrl = core$4.getGerritProjectsApiUrl;
-exports.getGerritRequestOptions = core$4.getGerritRequestOptions;
-exports.getGitilesAuthenticationUrl = core$4.getGitilesAuthenticationUrl;
-exports.parseGerritGitilesUrl = core$4.parseGerritGitilesUrl;
-exports.parseGerritJsonResponse = core$4.parseGerritJsonResponse;
-exports.parseGitilesUrlRef = core$4.parseGitilesUrlRef;
+exports.readGerritIntegrationConfig = config$6.readGerritIntegrationConfig;
+exports.readGerritIntegrationConfigs = config$6.readGerritIntegrationConfigs;
+exports.buildGerritGitilesArchiveUrlFromLocation = core$3.buildGerritGitilesArchiveUrlFromLocation;
+exports.getGerritBranchApiUrl = core$3.getGerritBranchApiUrl;
+exports.getGerritCloneRepoUrl = core$3.getGerritCloneRepoUrl;
+exports.getGerritFileContentsApiUrl = core$3.getGerritFileContentsApiUrl;
+exports.getGerritProjectsApiUrl = core$3.getGerritProjectsApiUrl;
+exports.getGerritRequestOptions = core$3.getGerritRequestOptions;
+exports.getGitilesAuthenticationUrl = core$3.getGitilesAuthenticationUrl;
+exports.parseGerritJsonResponse = core$3.parseGerritJsonResponse;
+exports.parseGitilesUrlRef = core$3.parseGitilesUrlRef;
 exports.GiteaIntegration = GiteaIntegration.GiteaIntegration;
-exports.getGiteaArchiveUrl = core$5.getGiteaArchiveUrl;
-exports.getGiteaEditContentsUrl = core$5.getGiteaEditContentsUrl;
-exports.getGiteaFileContentsUrl = core$5.getGiteaFileContentsUrl;
-exports.getGiteaLatestCommitUrl = core$5.getGiteaLatestCommitUrl;
-exports.getGiteaRequestOptions = core$5.getGiteaRequestOptions;
-exports.parseGiteaUrl = core$5.parseGiteaUrl;
-exports.readGiteaConfig = config$8.readGiteaConfig;
-exports.readGithubIntegrationConfig = config$9.readGithubIntegrationConfig;
-exports.readGithubIntegrationConfigs = config$9.readGithubIntegrationConfigs;
-exports.getGitHubRequestOptions = core$6.getGitHubRequestOptions;
-exports.getGithubFileFetchUrl = core$6.getGithubFileFetchUrl;
+exports.getGiteaArchiveUrl = core$4.getGiteaArchiveUrl;
+exports.getGiteaEditContentsUrl = core$4.getGiteaEditContentsUrl;
+exports.getGiteaFileContentsUrl = core$4.getGiteaFileContentsUrl;
+exports.getGiteaLatestCommitUrl = core$4.getGiteaLatestCommitUrl;
+exports.getGiteaRequestOptions = core$4.getGiteaRequestOptions;
+exports.parseGiteaUrl = core$4.parseGiteaUrl;
+exports.readGiteaConfig = config$7.readGiteaConfig;
+exports.readGithubIntegrationConfig = config$8.readGithubIntegrationConfig;
+exports.readGithubIntegrationConfigs = config$8.readGithubIntegrationConfigs;
+exports.getGithubFileFetchUrl = core$5.getGithubFileFetchUrl;
 exports.DefaultGithubCredentialsProvider = DefaultGithubCredentialsProvider.DefaultGithubCredentialsProvider;
 exports.GithubAppCredentialsMux = SingleInstanceGithubCredentialsProvider.GithubAppCredentialsMux;
 exports.SingleInstanceGithubCredentialsProvider = SingleInstanceGithubCredentialsProvider.SingleInstanceGithubCredentialsProvider;
 exports.GithubIntegration = GithubIntegration.GithubIntegration;
 exports.replaceGithubUrlType = GithubIntegration.replaceGithubUrlType;
-exports.getGitLabIntegrationRelativePath = config$a.getGitLabIntegrationRelativePath;
-exports.readGitLabIntegrationConfig = config$a.readGitLabIntegrationConfig;
-exports.readGitLabIntegrationConfigs = config$a.readGitLabIntegrationConfigs;
-exports.getGitLabFileFetchUrl = core$7.getGitLabFileFetchUrl;
-exports.getGitLabRequestOptions = core$7.getGitLabRequestOptions;
+exports.getGitLabIntegrationRelativePath = config$9.getGitLabIntegrationRelativePath;
+exports.readGitLabIntegrationConfig = config$9.readGitLabIntegrationConfig;
+exports.readGitLabIntegrationConfigs = config$9.readGitLabIntegrationConfigs;
+exports.getGitLabFileFetchUrl = core$6.getGitLabFileFetchUrl;
+exports.getGitLabRequestOptions = core$6.getGitLabRequestOptions;
 exports.GitLabIntegration = GitLabIntegration.GitLabIntegration;
 exports.replaceGitLabUrlType = GitLabIntegration.replaceGitLabUrlType;
 exports.DefaultGitlabCredentialsProvider = DefaultGitlabCredentialsProvider.DefaultGitlabCredentialsProvider;
-exports.readGoogleGcsIntegrationConfig = config$b.readGoogleGcsIntegrationConfig;
+exports.readGoogleGcsIntegrationConfig = config$a.readGoogleGcsIntegrationConfig;
 exports.GoogleGcsIntegration = GoogleGcsIntegration.GoogleGcsIntegration;
 exports.HarnessIntegration = HarnessIntegration.HarnessIntegration;
-exports.getHarnessArchiveUrl = core$8.getHarnessArchiveUrl;
-exports.getHarnessFileContentsUrl = core$8.getHarnessFileContentsUrl;
-exports.getHarnessLatestCommitUrl = core$8.getHarnessLatestCommitUrl;
-exports.getHarnessRequestOptions = core$8.getHarnessRequestOptions;
-exports.parseHarnessUrl = core$8.parseHarnessUrl;
-exports.readHarnessConfig = config$c.readHarnessConfig;
+exports.getHarnessArchiveUrl = core$7.getHarnessArchiveUrl;
+exports.getHarnessFileContentsUrl = core$7.getHarnessFileContentsUrl;
+exports.getHarnessLatestCommitUrl = core$7.getHarnessLatestCommitUrl;
+exports.getHarnessRequestOptions = core$7.getHarnessRequestOptions;
+exports.parseHarnessUrl = core$7.parseHarnessUrl;
+exports.readHarnessConfig = config$b.readHarnessConfig;
 exports.defaultScmResolveUrl = helpers.defaultScmResolveUrl;
 exports.ScmIntegrations = ScmIntegrations.ScmIntegrations;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -351,22 +351,6 @@ type AzureIntegrationConfig = {
      * 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.
-     *
-     * @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.
@@ -584,87 +568,6 @@ declare class BitbucketCloudIntegration implements ScmIntegration {
     resolveEditUrl(url: string): string;
 }
 
-/**
- * The configuration parameters for a single Bitbucket API provider.
- *
- * @public
- * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
- */
-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;
-    /**
-     * Signing key for commits
-     */
-    commitSigningKey?: string;
-};
-/**
- * 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 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
- * @deprecated bitbucket integration replaced by integrations bitbucketCloud and bitbucketServer.
- */
-declare function readBitbucketIntegrationConfigs(configs: Config[]): BitbucketIntegrationConfig[];
-
-/**
- * A Bitbucket based integration.
- *
- * @public
- * @deprecated replaced by the integrations bitbucketCloud and bitbucketServer.
- */
-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;
-}
-
 /**
  * The configuration parameters for a single Bitbucket Server API provider.
  *
@@ -996,6 +899,26 @@ type GitLabIntegrationConfig = {
      * Signing key to sign commits
      */
     commitSigningKey?: string;
+    /**
+     * Retry configuration for failed requests.
+     */
+    retry?: {
+        /**
+         * Maximum number of retries for failed requests
+         * @defaultValue 0
+         */
+        maxRetries?: number;
+        /**
+         * HTTP status codes that should trigger a retry
+         * @defaultValue []
+         */
+        retryStatusCodes?: number[];
+        /**
+         * Rate limit for requests per minute
+         * @defaultValue -1
+         */
+        maxApiRequestsPerMinute?: number;
+    };
 };
 /**
  * Reads a single GitLab integration config.
@@ -1029,6 +952,7 @@ declare function getGitLabIntegrationRelativePath(config: GitLabIntegrationConfi
 declare class GitLabIntegration implements ScmIntegration {
     private readonly integrationConfig;
     static factory: ScmIntegrationsFactory<GitLabIntegration>;
+    private readonly fetchImpl;
     constructor(integrationConfig: GitLabIntegrationConfig);
     get type(): string;
     get title(): string;
@@ -1039,6 +963,9 @@ declare class GitLabIntegration implements ScmIntegration {
         lineNumber?: number;
     }): string;
     resolveEditUrl(url: string): string;
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+    private createFetchStrategy;
+    private withRetry;
 }
 /**
  * Takes a GitLab URL and replaces the type part (blob, tree etc).
@@ -1161,10 +1088,6 @@ interface ScmIntegrationRegistry extends ScmIntegrationsGroup<ScmIntegration> {
     awsCodeCommit: ScmIntegrationsGroup<AwsCodeCommitIntegration>;
     azureBlobStorage: ScmIntegrationsGroup<AzureBlobStorageIntergation>;
     azure: ScmIntegrationsGroup<AzureIntegration>;
-    /**
-     * @deprecated in favor of `bitbucketCloud` and `bitbucketServer`
-     */
-    bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
     bitbucketCloud: ScmIntegrationsGroup<BitbucketCloudIntegration>;
     bitbucketServer: ScmIntegrationsGroup<BitbucketServerIntegration>;
     gerrit: ScmIntegrationsGroup<GerritIntegration>;
@@ -1304,64 +1227,6 @@ declare class DefaultAzureDevOpsCredentialsProvider implements AzureDevOpsCreden
     }): 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>;
-};
-
 /**
  * Fetches an OAuth access token from Bitbucket Cloud using client credentials flow.
  * Tokens are cached with a 10-minute grace period to account for clock skew.
@@ -1458,37 +1323,6 @@ declare function getBitbucketServerRequestOptions(config: BitbucketServerIntegra
     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
- * @deprecated `parseGerritGitilesUrl` is deprecated. Use
- *  {@link parseGitilesUrlRef} instead.
- */
-declare function parseGerritGitilesUrl(config: GerritIntegrationConfig, url: string): {
-    branch: string;
-    filePath: string;
-    project: string;
-};
 /**
  * Parses Gitiles urls and returns the following:
  *
@@ -1515,18 +1349,6 @@ declare function parseGitilesUrlRef(config: GerritIntegrationConfig, url: string
     refType: 'sha' | 'branch' | 'tag' | 'head';
     basePath: 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
- * @deprecated `buildGerritGitilesArchiveUrl` is deprecated. Use
- *  {@link buildGerritGitilesArchiveUrlFromLocation} instead.
- */
-declare function buildGerritGitilesArchiveUrl(config: GerritIntegrationConfig, project: string, branch: string, filePath: string): string;
 /**
  * Build a Gerrit Gitiles archive url from a Gitiles url.
  *
@@ -1731,16 +1553,6 @@ interface GithubCredentialsProvider {
  * @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.
@@ -1840,16 +1652,17 @@ declare class SingleInstanceGithubCredentialsProvider implements GithubCredentia
  *
  * Converts
  * from: https://gitlab.example.com/a/b/blob/master/c.yaml
- * to:   https://gitlab.com/api/v4/projects/projectId/repository/c.yaml?ref=master
+ * to:   https://gitlab.com/api/v4/projects/a%2Fb/repository/files/c.yaml/raw?ref=master
  * -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
+ * to:   https://gitlab.com/api/v4/projects/groupA%2Fteams%2FteamA%2FsubgroupA%2FrepoA/repository/files/filepath/raw?ref=branch
  *
  * @param url - A URL pointing to a file
  * @param config - The relevant provider config
+ * @param token - An optional auth token (not used in path extraction, kept for compatibility)
  * @public
  */
-declare function getGitLabFileFetchUrl(url: string, config: GitLabIntegrationConfig, token?: string): Promise<string>;
+declare function getGitLabFileFetchUrl(url: string, config: GitLabIntegrationConfig, _token?: string): Promise<string>;
 /**
  * Gets the request options necessary to make requests to a given provider.
  *
@@ -2035,10 +1848,6 @@ interface IntegrationsByType {
     awsCodeCommit: ScmIntegrationsGroup<AwsCodeCommitIntegration>;
     azureBlobStorage: ScmIntegrationsGroup<AzureBlobStorageIntergation>;
     azure: ScmIntegrationsGroup<AzureIntegration>;
-    /**
-     * @deprecated in favor of `bitbucketCloud` and `bitbucketServer`
-     */
-    bitbucket: ScmIntegrationsGroup<BitbucketIntegration>;
     bitbucketCloud: ScmIntegrationsGroup<BitbucketCloudIntegration>;
     bitbucketServer: ScmIntegrationsGroup<BitbucketServerIntegration>;
     gerrit: ScmIntegrationsGroup<GerritIntegration>;
@@ -2061,10 +1870,6 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     get awsCodeCommit(): ScmIntegrationsGroup<AwsCodeCommitIntegration>;
     get azureBlobStorage(): ScmIntegrationsGroup<AzureBlobStorageIntergation>;
     get azure(): ScmIntegrationsGroup<AzureIntegration>;
-    /**
-     * @deprecated in favor of `bitbucketCloud()` and `bitbucketServer()`
-     */
-    get bitbucket(): ScmIntegrationsGroup<BitbucketIntegration>;
     get bitbucketCloud(): ScmIntegrationsGroup<BitbucketCloudIntegration>;
     get bitbucketServer(): ScmIntegrationsGroup<BitbucketServerIntegration>;
     get gerrit(): ScmIntegrationsGroup<GerritIntegration>;
@@ -2084,5 +1889,5 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     resolveEditUrl(url: string): string;
 }
 
-export { AwsCodeCommitIntegration, AwsS3Integration, AzureBlobStorageIntergation, AzureIntegration, BitbucketCloudIntegration, BitbucketIntegration, BitbucketServerIntegration, DefaultAzureCredentialsManager, DefaultAzureDevOpsCredentialsProvider, DefaultGithubCredentialsProvider, DefaultGitlabCredentialsProvider, GerritIntegration, GitLabIntegration, GiteaIntegration, GithubAppCredentialsMux, GithubIntegration, GoogleGcsIntegration, HarnessIntegration, ScmIntegrations, SingleInstanceGithubCredentialsProvider, buildGerritGitilesArchiveUrl, buildGerritGitilesArchiveUrlFromLocation, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getAzureRequestOptions, getBitbucketCloudDefaultBranch, getBitbucketCloudDownloadUrl, getBitbucketCloudFileFetchUrl, getBitbucketCloudOAuthToken, getBitbucketCloudRequestOptions, getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions, getBitbucketServerDefaultBranch, getBitbucketServerDownloadUrl, getBitbucketServerFileFetchUrl, getBitbucketServerRequestOptions, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabIntegrationRelativePath, getGitLabRequestOptions, getGiteaArchiveUrl, getGiteaEditContentsUrl, getGiteaFileContentsUrl, getGiteaLatestCommitUrl, getGiteaRequestOptions, getGithubFileFetchUrl, getGitilesAuthenticationUrl, getHarnessArchiveUrl, getHarnessFileContentsUrl, getHarnessLatestCommitUrl, getHarnessRequestOptions, parseGerritGitilesUrl, parseGerritJsonResponse, parseGiteaUrl, parseGitilesUrlRef, parseHarnessUrl, readAwsCodeCommitIntegrationConfig, readAwsCodeCommitIntegrationConfigs, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureBlobStorageIntegrationConfig, readAzureBlobStorageIntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGiteaConfig, readGithubIntegrationConfig, readGithubIntegrationConfigs, readGoogleGcsIntegrationConfig, readHarnessConfig, replaceGitLabUrlType, replaceGithubUrlType };
-export type { AwsCodeCommitIntegrationConfig, AwsS3IntegrationConfig, AzureBlobStorageIntegrationConfig, AzureClientSecretCredential, AzureCredentialBase, AzureCredentialsManager, AzureDevOpsCredential, AzureDevOpsCredentialKind, AzureDevOpsCredentialLike, AzureDevOpsCredentialType, AzureDevOpsCredentials, AzureDevOpsCredentialsProvider, AzureIntegrationConfig, AzureManagedIdentityClientAssertionCredential, AzureManagedIdentityCredential, BitbucketCloudIntegrationConfig, BitbucketIntegrationConfig, BitbucketServerIntegrationConfig, GerritIntegrationConfig, GitLabIntegrationConfig, GiteaIntegrationConfig, GithubAppConfig, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GithubIntegrationConfig, GitlabCredentials, GitlabCredentialsProvider, GoogleGcsIntegrationConfig, HarnessIntegrationConfig, IntegrationsByType, PersonalAccessTokenCredential, RateLimitInfo, ScmIntegration, ScmIntegrationRegistry, ScmIntegrationsFactory, ScmIntegrationsGroup };
+export { AwsCodeCommitIntegration, AwsS3Integration, AzureBlobStorageIntergation, AzureIntegration, BitbucketCloudIntegration, BitbucketServerIntegration, DefaultAzureCredentialsManager, DefaultAzureDevOpsCredentialsProvider, DefaultGithubCredentialsProvider, DefaultGitlabCredentialsProvider, GerritIntegration, GitLabIntegration, GiteaIntegration, GithubAppCredentialsMux, GithubIntegration, GoogleGcsIntegration, HarnessIntegration, ScmIntegrations, SingleInstanceGithubCredentialsProvider, buildGerritGitilesArchiveUrlFromLocation, defaultScmResolveUrl, getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl, getBitbucketCloudDefaultBranch, getBitbucketCloudDownloadUrl, getBitbucketCloudFileFetchUrl, getBitbucketCloudOAuthToken, getBitbucketCloudRequestOptions, getBitbucketServerDefaultBranch, getBitbucketServerDownloadUrl, getBitbucketServerFileFetchUrl, getBitbucketServerRequestOptions, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitLabFileFetchUrl, getGitLabIntegrationRelativePath, getGitLabRequestOptions, getGiteaArchiveUrl, getGiteaEditContentsUrl, getGiteaFileContentsUrl, getGiteaLatestCommitUrl, getGiteaRequestOptions, getGithubFileFetchUrl, getGitilesAuthenticationUrl, getHarnessArchiveUrl, getHarnessFileContentsUrl, getHarnessLatestCommitUrl, getHarnessRequestOptions, parseGerritJsonResponse, parseGiteaUrl, parseGitilesUrlRef, parseHarnessUrl, readAwsCodeCommitIntegrationConfig, readAwsCodeCommitIntegrationConfigs, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureBlobStorageIntegrationConfig, readAzureBlobStorageIntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs, readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGiteaConfig, readGithubIntegrationConfig, readGithubIntegrationConfigs, readGoogleGcsIntegrationConfig, readHarnessConfig, replaceGitLabUrlType, replaceGithubUrlType };
+export type { AwsCodeCommitIntegrationConfig, AwsS3IntegrationConfig, AzureBlobStorageIntegrationConfig, AzureClientSecretCredential, AzureCredentialBase, AzureCredentialsManager, AzureDevOpsCredential, AzureDevOpsCredentialKind, AzureDevOpsCredentialLike, AzureDevOpsCredentialType, AzureDevOpsCredentials, AzureDevOpsCredentialsProvider, AzureIntegrationConfig, AzureManagedIdentityClientAssertionCredential, AzureManagedIdentityCredential, BitbucketCloudIntegrationConfig, BitbucketServerIntegrationConfig, GerritIntegrationConfig, GitLabIntegrationConfig, GiteaIntegrationConfig, GithubAppConfig, GithubCredentialType, GithubCredentials, GithubCredentialsProvider, GithubIntegrationConfig, GitlabCredentials, GitlabCredentialsProvider, GoogleGcsIntegrationConfig, HarnessIntegrationConfig, IntegrationsByType, PersonalAccessTokenCredential, RateLimitInfo, ScmIntegration, ScmIntegrationRegistry, ScmIntegrationsFactory, ScmIntegrationsGroup };

package/dist/index.esm.js

@@ -9,10 +9,6 @@ export { AzureIntegration } from './azure/AzureIntegration.esm.js';
 export { readAzureIntegrationConfig, readAzureIntegrationConfigs } from './azure/config.esm.js';
 export { getAzureCommitsUrl, getAzureDownloadUrl, getAzureFileFetchUrl } from './azure/core.esm.js';
 export { DefaultAzureDevOpsCredentialsProvider } from './azure/DefaultAzureDevOpsCredentialsProvider.esm.js';
-export { getAzureRequestOptions } from './azure/deprecated.esm.js';
-export { BitbucketIntegration } from './bitbucket/BitbucketIntegration.esm.js';
-export { readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs } from './bitbucket/config.esm.js';
-export { getBitbucketDefaultBranch, getBitbucketDownloadUrl, getBitbucketFileFetchUrl, getBitbucketRequestOptions } from './bitbucket/core.esm.js';
 export { BitbucketCloudIntegration } from './bitbucketCloud/BitbucketCloudIntegration.esm.js';
 export { readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs } from './bitbucketCloud/config.esm.js';
 export { getBitbucketCloudDefaultBranch, getBitbucketCloudDownloadUrl, getBitbucketCloudFileFetchUrl, getBitbucketCloudOAuthToken, getBitbucketCloudRequestOptions } from './bitbucketCloud/core.esm.js';
@@ -21,12 +17,12 @@ export { readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationCon
 export { getBitbucketServerDefaultBranch, getBitbucketServerDownloadUrl, getBitbucketServerFileFetchUrl, getBitbucketServerRequestOptions } from './bitbucketServer/core.esm.js';
 export { GerritIntegration } from './gerrit/GerritIntegration.esm.js';
 export { readGerritIntegrationConfig, readGerritIntegrationConfigs } from './gerrit/config.esm.js';
-export { buildGerritGitilesArchiveUrl, buildGerritGitilesArchiveUrlFromLocation, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitilesAuthenticationUrl, parseGerritGitilesUrl, parseGerritJsonResponse, parseGitilesUrlRef } from './gerrit/core.esm.js';
+export { buildGerritGitilesArchiveUrlFromLocation, getGerritBranchApiUrl, getGerritCloneRepoUrl, getGerritFileContentsApiUrl, getGerritProjectsApiUrl, getGerritRequestOptions, getGitilesAuthenticationUrl, parseGerritJsonResponse, parseGitilesUrlRef } from './gerrit/core.esm.js';
 export { GiteaIntegration } from './gitea/GiteaIntegration.esm.js';
 export { getGiteaArchiveUrl, getGiteaEditContentsUrl, getGiteaFileContentsUrl, getGiteaLatestCommitUrl, getGiteaRequestOptions, parseGiteaUrl } from './gitea/core.esm.js';
 export { readGiteaConfig } from './gitea/config.esm.js';
 export { readGithubIntegrationConfig, readGithubIntegrationConfigs } from './github/config.esm.js';
-export { getGitHubRequestOptions, getGithubFileFetchUrl } from './github/core.esm.js';
+export { getGithubFileFetchUrl } from './github/core.esm.js';
 export { DefaultGithubCredentialsProvider } from './github/DefaultGithubCredentialsProvider.esm.js';
 export { GithubAppCredentialsMux, SingleInstanceGithubCredentialsProvider } from './github/SingleInstanceGithubCredentialsProvider.esm.js';
 export { GithubIntegration, replaceGithubUrlType } from './github/GithubIntegration.esm.js';

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/integration",
-  "version": "1.20.0",
+  "version": "2.0.0-next.1",
   "description": "Helpers for managing integrations towards external systems",
   "backstage": {
     "role": "common-library"
@@ -39,18 +39,19 @@
   "dependencies": {
     "@azure/identity": "^4.0.0",
     "@azure/storage-blob": "^12.5.0",
-    "@backstage/config": "^1.3.6",
-    "@backstage/errors": "^1.2.7",
+    "@backstage/config": "1.3.6",
+    "@backstage/errors": "1.2.7",
     "@octokit/auth-app": "^4.0.0",
     "@octokit/rest": "^19.0.3",
     "cross-fetch": "^4.0.0",
     "git-url-parse": "^15.0.0",
     "lodash": "^4.17.21",
-    "luxon": "^3.0.0"
+    "luxon": "^3.0.0",
+    "p-throttle": "^4.1.1"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.35.4",
-    "@backstage/config-loader": "^1.10.8",
+    "@backstage/cli": "0.36.0-next.1",
+    "@backstage/config-loader": "1.10.9-next.0",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts",

package/dist/azure/deprecated.cjs.js

@@ -1,26 +0,0 @@
-'use strict';
-
-var CachedAzureDevOpsCredentialsProvider = require('./CachedAzureDevOpsCredentialsProvider.cjs.js');
-
-async function getAzureRequestOptions(config, additionalHeaders) {
-  const headers = additionalHeaders ? { ...additionalHeaders } : {};
-  const credentialConfig = config.credentials?.filter(
-    (credential) => credential.organizations === void 0 || credential.organizations.length === 0
-  )[0];
-  if (credentialConfig) {
-    const credentialsProvider = CachedAzureDevOpsCredentialsProvider.CachedAzureDevOpsCredentialsProvider.fromAzureDevOpsCredential(
-      credentialConfig
-    );
-    const credentials = await credentialsProvider.getCredentials();
-    return {
-      headers: {
-        ...credentials?.headers,
-        ...headers
-      }
-    };
-  }
-  return { headers };
-}
-
-exports.getAzureRequestOptions = getAzureRequestOptions;
-//# sourceMappingURL=deprecated.cjs.js.map

package/dist/azure/deprecated.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"deprecated.cjs.js","sources":["../../src/azure/deprecated.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 */\nimport { AzureIntegrationConfig } from './config';\nimport { CachedAzureDevOpsCredentialsProvider } from './CachedAzureDevOpsCredentialsProvider';\n\n/**\n * Gets the request options necessary to make requests to a given provider.\n *\n * @param config - The relevant provider config\n * @param additionalHeaders - Additional headers for the request\n * @public\n * @deprecated Use {@link AzureDevOpsCredentialsProvider} instead.\n */\nexport async function getAzureRequestOptions(\n  config: AzureIntegrationConfig,\n  additionalHeaders?: Record<string, string>,\n): Promise<{ headers: Record<string, string> }> {\n  const headers: Record<string, string> = additionalHeaders\n    ? { ...additionalHeaders }\n    : {};\n\n  /*\n   * Since we do not have a way to determine which organization the request is for,\n   * we will use the first credential that does not have an organization specified.\n   */\n  const credentialConfig = config.credentials?.filter(\n    credential =>\n      credential.organizations === undefined ||\n      credential.organizations.length === 0,\n  )[0];\n\n  if (credentialConfig) {\n    const credentialsProvider =\n      CachedAzureDevOpsCredentialsProvider.fromAzureDevOpsCredential(\n        credentialConfig,\n      );\n    const credentials = await credentialsProvider.getCredentials();\n\n    return {\n      headers: {\n        ...credentials?.headers,\n        ...headers,\n      },\n    };\n  }\n\n  return { headers };\n}\n"],"names":["CachedAzureDevOpsCredentialsProvider"],"mappings":";;;;AA0BA,eAAsB,sBAAA,CACpB,QACA,iBAAA,EAC8C;AAC9C,EAAA,MAAM,UAAkC,iBAAA,GACpC,EAAE,GAAG,iBAAA,KACL,EAAC;AAML,EAAA,MAAM,gBAAA,GAAmB,OAAO,WAAA,EAAa,MAAA;AAAA,IAC3C,gBACE,UAAA,CAAW,aAAA,KAAkB,MAAA,IAC7B,UAAA,CAAW,cAAc,MAAA,KAAW;AAAA,IACtC,CAAC,CAAA;AAEH,EAAA,IAAI,gBAAA,EAAkB;AACpB,IAAA,MAAM,sBACJA,yEAAA,CAAqC,yBAAA;AAAA,MACnC;AAAA,KACF;AACF,IAAA,MAAM,WAAA,GAAc,MAAM,mBAAA,CAAoB,cAAA,EAAe;AAE7D,IAAA,OAAO;AAAA,MACL,OAAA,EAAS;AAAA,QACP,GAAG,WAAA,EAAa,OAAA;AAAA,QAChB,GAAG;AAAA;AACL,KACF;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,OAAA,EAAQ;AACnB;;;;"}