@backstage/integration 1.11.0 → 1.12.0-next.1

package/dist/index.d.ts

@@ -199,6 +199,10 @@ type AwsCodeCommitIntegrationConfig = {
      * (Optional) External ID to use when assuming role
      */
     externalId?: string;
+    /**
+     * region to use for AWS (default: us-east-1)
+     */
+    region: string;
 };
 /**
  * Reads a single Aws CodeCommit integration config.
@@ -1576,41 +1580,6 @@ declare class SingleInstanceGithubCredentialsProvider implements GithubCredentia
     }): Promise<GithubCredentials>;
 }
 
-/**
- * @public
- * @deprecated Use {@link getGithubFileFetchUrl} instead.
- */
-declare const getGitHubFileFetchUrl: typeof getGithubFileFetchUrl;
-/**
- * @public
- * @deprecated Use {@link GithubIntegrationConfig} instead.
- */
-type GitHubIntegrationConfig = GithubIntegrationConfig;
-/**
- * @public
- * @deprecated Use {@link GithubIntegration} instead.
- */
-declare class GitHubIntegration extends GithubIntegration {
-    static factory: ScmIntegrationsFactory<GitHubIntegration>;
-    constructor(integrationConfig: GitHubIntegrationConfig);
-    get config(): GitHubIntegrationConfig;
-}
-/**
- * @public
- * @deprecated Use {@link readGithubIntegrationConfig} instead.
- */
-declare const readGitHubIntegrationConfig: typeof readGithubIntegrationConfig;
-/**
- * @public
- * @deprecated Use {@link readGithubIntegrationConfigs} instead.
- */
-declare const readGitHubIntegrationConfigs: typeof readGithubIntegrationConfigs;
-/**
- * @public
- * @deprecated Use {@link replaceGithubUrlType} instead.
- */
-declare const replaceGitHubUrlType: typeof replaceGithubUrlType;
-
 /**
  * Given a URL pointing to a file on a provider, returns a URL that is suitable
  * for fetching the contents of the data.
@@ -1696,7 +1665,7 @@ declare function readGoogleGcsIntegrationConfig(config: Config): GoogleGcsIntegr
 
 /**
  * Given a file path URL,
- * it returns an API URL which returns the contents of the file.
+ * it returns an API URL which returns the contents of the file .
  * @remarks
  *
  * Converts
@@ -1708,6 +1677,36 @@ declare function readGoogleGcsIntegrationConfig(config: Config): GoogleGcsIntegr
  * @public
  */
 declare function getHarnessFileContentsUrl(config: HarnessIntegrationConfig, url: string): string;
+/**
+ * Given a URL pointing to a repository/path, returns a URL
+ * for archive contents of the repository.
+ *
+ * @remarks
+ *
+ * Converts
+ * from: https://qa.harness.io/ng/account/accountId/module/code/orgs/orgId/projects/projectName/repos/repoName/files/branch/~/fileName
+ * to:   https://qa.harness.io/gateway/code/api/v1/repos/accountId/orgId/projectName/repoName/+/archive/branch.zip?routingId=accountId
+ *
+ * @param url - A URL pointing to a repository/path
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getHarnessArchiveUrl(config: HarnessIntegrationConfig, url: string): string;
+/**
+ * Given a URL pointing to a repository branch, returns a URL
+ * for latest commit information.
+ *
+ * @remarks
+ *
+ * Converts
+ * from: https://app.harness.io/ng/account/accountId/module/code/orgs/orgName/projects/projectName/repos/repoName/files/branchName
+ * to:   https://app.harness.io/gateway/code/api/v1/repos/accountId/orgName/projectName/repoName/+/content?routingId=accountId&include_commit=true&git_ref=refs/heads/branchName
+ *
+ * @param url - A URL pointing to a repository branch
+ * @param config - The relevant provider config
+ * @public
+ */
+declare function getHarnessLatestCommitUrl(config: HarnessIntegrationConfig, url: string): string;
 /**
  * Return request headers for a Harness Code provider.
  *
@@ -1717,6 +1716,24 @@ declare function getHarnessFileContentsUrl(config: HarnessIntegrationConfig, url
 declare function getHarnessRequestOptions(config: HarnessIntegrationConfig): {
     headers?: Record<string, string>;
 };
+/**
+ * Return parsed git url properties.
+ *
+ * @param config - A Harness provider config
+ * @param url - A URL pointing to a repository
+ * @public
+ */
+declare function parseHarnessUrl(config: HarnessIntegrationConfig, url: string): {
+    baseUrl: string;
+    accountId: string;
+    orgName: string;
+    projectName: string;
+    refString: string;
+    repoName: string;
+    path: string;
+    refDashStr: string;
+    branch: string;
+};
 
 /**
  * Default implementation of {@link ScmIntegration} `resolveUrl`, that only
@@ -1785,4 +1802,4 @@ declare class ScmIntegrations implements ScmIntegrationRegistry {
     resolveEditUrl(url: string): string;
 }
 
-export { AwsCodeCommitIntegration, type AwsCodeCommitIntegrationConfig, AwsS3Integration, type AwsS3IntegrationConfig, type AzureClientSecretCredential, type AzureCredentialBase, type AzureDevOpsCredential, type AzureDevOpsCredentialKind, type AzureDevOpsCredentialLike, type AzureDevOpsCredentialType, type AzureDevOpsCredentials, type AzureDevOpsCredentialsProvider, AzureIntegration, type AzureIntegrationConfig, type AzureManagedIdentityCredential, BitbucketCloudIntegration, type BitbucketCloudIntegrationConfig, BitbucketIntegration, type BitbucketIntegrationConfig, BitbucketServerIntegration, type BitbucketServerIntegrationConfig, DefaultAzureDevOpsCredentialsProvider, DefaultGithubCredentialsProvider, DefaultGitlabCredentialsProvider, GerritIntegration, type GerritIntegrationConfig, GitHubIntegration, type GitHubIntegrationConfig, GitLabIntegration, type GitLabIntegrationConfig, GiteaIntegration, type GiteaIntegrationConfig, type GithubAppConfig, GithubAppCredentialsMux, type GithubCredentialType, type GithubCredentials, type GithubCredentialsProvider, GithubIntegration, type GithubIntegrationConfig, type GitlabCredentials, type GitlabCredentialsProvider, type GoogleGcsIntegrationConfig, HarnessIntegration, type HarnessIntegrationConfig, type IntegrationsByType, type PersonalAccessTokenCredential, type RateLimitInfo, type ScmIntegration, type ScmIntegrationRegistry, ScmIntegrations, type ScmIntegrationsFactory, type 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, getGiteaArchiveUrl, getGiteaEditContentsUrl, getGiteaFileContentsUrl, getGiteaLatestCommitUrl, getGiteaRequestOptions, getGithubFileFetchUrl, getHarnessFileContentsUrl, getHarnessRequestOptions, parseGerritGitilesUrl, parseGerritJsonResponse, parseGiteaUrl, readAwsCodeCommitIntegrationConfig, readAwsCodeCommitIntegrationConfigs, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGiteaConfig, readGithubIntegrationConfig, readGithubIntegrationConfigs, readGoogleGcsIntegrationConfig, readHarnessConfig, replaceGitHubUrlType, replaceGitLabUrlType, replaceGithubUrlType };
+export { AwsCodeCommitIntegration, type AwsCodeCommitIntegrationConfig, AwsS3Integration, type AwsS3IntegrationConfig, type AzureClientSecretCredential, type AzureCredentialBase, type AzureDevOpsCredential, type AzureDevOpsCredentialKind, type AzureDevOpsCredentialLike, type AzureDevOpsCredentialType, type AzureDevOpsCredentials, type AzureDevOpsCredentialsProvider, AzureIntegration, type AzureIntegrationConfig, type AzureManagedIdentityCredential, BitbucketCloudIntegration, type BitbucketCloudIntegrationConfig, BitbucketIntegration, type BitbucketIntegrationConfig, BitbucketServerIntegration, type BitbucketServerIntegrationConfig, DefaultAzureDevOpsCredentialsProvider, DefaultGithubCredentialsProvider, DefaultGitlabCredentialsProvider, GerritIntegration, type GerritIntegrationConfig, GitLabIntegration, type GitLabIntegrationConfig, GiteaIntegration, type GiteaIntegrationConfig, type GithubAppConfig, GithubAppCredentialsMux, type GithubCredentialType, type GithubCredentials, type GithubCredentialsProvider, GithubIntegration, type GithubIntegrationConfig, type GitlabCredentials, type GitlabCredentialsProvider, type GoogleGcsIntegrationConfig, HarnessIntegration, type HarnessIntegrationConfig, type IntegrationsByType, type PersonalAccessTokenCredential, type RateLimitInfo, type ScmIntegration, type ScmIntegrationRegistry, ScmIntegrations, type ScmIntegrationsFactory, type 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, getGitHubRequestOptions, getGitLabFileFetchUrl, getGitLabIntegrationRelativePath, getGitLabRequestOptions, getGiteaArchiveUrl, getGiteaEditContentsUrl, getGiteaFileContentsUrl, getGiteaLatestCommitUrl, getGiteaRequestOptions, getGithubFileFetchUrl, getHarnessArchiveUrl, getHarnessFileContentsUrl, getHarnessLatestCommitUrl, getHarnessRequestOptions, parseGerritGitilesUrl, parseGerritJsonResponse, parseGiteaUrl, parseHarnessUrl, readAwsCodeCommitIntegrationConfig, readAwsCodeCommitIntegrationConfigs, readAwsS3IntegrationConfig, readAwsS3IntegrationConfigs, readAzureIntegrationConfig, readAzureIntegrationConfigs, readBitbucketCloudIntegrationConfig, readBitbucketCloudIntegrationConfigs, readBitbucketIntegrationConfig, readBitbucketIntegrationConfigs, readBitbucketServerIntegrationConfig, readBitbucketServerIntegrationConfigs, readGerritIntegrationConfig, readGerritIntegrationConfigs, readGitLabIntegrationConfig, readGitLabIntegrationConfigs, readGiteaConfig, readGithubIntegrationConfig, readGithubIntegrationConfigs, readGoogleGcsIntegrationConfig, readHarnessConfig, replaceGitLabUrlType, replaceGithubUrlType };

package/dist/index.esm.js

@@ -27,14 +27,13 @@ export { getGitHubRequestOptions, getGithubFileFetchUrl } from './github/core.es
 export { DefaultGithubCredentialsProvider } from './github/DefaultGithubCredentialsProvider.esm.js';
 export { GithubAppCredentialsMux, SingleInstanceGithubCredentialsProvider } from './github/SingleInstanceGithubCredentialsProvider.esm.js';
 export { GithubIntegration, replaceGithubUrlType } from './github/GithubIntegration.esm.js';
-export { GitHubIntegration, getGitHubFileFetchUrl, readGitHubIntegrationConfig, readGitHubIntegrationConfigs, replaceGitHubUrlType } from './github/deprecated.esm.js';
 export { getGitLabIntegrationRelativePath, readGitLabIntegrationConfig, readGitLabIntegrationConfigs } from './gitlab/config.esm.js';
 export { getGitLabFileFetchUrl, getGitLabRequestOptions } from './gitlab/core.esm.js';
 export { GitLabIntegration, replaceGitLabUrlType } from './gitlab/GitLabIntegration.esm.js';
 export { DefaultGitlabCredentialsProvider } from './gitlab/DefaultGitlabCredentialsProvider.esm.js';
 export { readGoogleGcsIntegrationConfig } from './googleGcs/config.esm.js';
 export { HarnessIntegration } from './harness/HarnessIntegration.esm.js';
-export { getHarnessFileContentsUrl, getHarnessRequestOptions } from './harness/core.esm.js';
+export { getHarnessArchiveUrl, getHarnessFileContentsUrl, getHarnessLatestCommitUrl, getHarnessRequestOptions, parseHarnessUrl } from './harness/core.esm.js';
 export { readHarnessConfig } from './harness/config.esm.js';
 export { defaultScmResolveUrl } from './helpers.esm.js';
 export { ScmIntegrations } from './ScmIntegrations.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.11.0",
+  "version": "1.12.0-next.1",
   "description": "Helpers for managing integrations towards external systems",
   "backstage": {
     "role": "common-library"
@@ -48,8 +48,8 @@
     "luxon": "^3.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.26.5",
-    "@backstage/config-loader": "^1.8.0",
+    "@backstage/cli": "^0.26.7-next.3",
+    "@backstage/config-loader": "^1.8.1-next.0",
     "@types/luxon": "^3.0.0",
     "msw": "^1.0.0"
   },

package/dist/github/deprecated.esm.js

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

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

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