adds factory type for creds provider and rename default

Signed-off-by: Brian Fletcher <brian@roadie.io>

packages/integration/api-report.md

@@ -92,17 +92,6 @@ export type BitbucketIntegrationConfig = {
   appPassword?: string;
 };
 
-// @public
-export class DefaultGithubCredentialsProvider
-  implements GithubCredentialsProvider
-{
-  // (undocumented)
-  static create(
-    config: GitHubIntegrationConfig,
-  ): DefaultGithubCredentialsProvider;
-  getCredentials(opts: { url: string }): Promise<GithubCredentials>;
-}
-
 // @public
 export function defaultScmResolveUrl(options: {
   url: string;
@@ -214,6 +203,11 @@ export interface GithubCredentialsProvider {
   getCredentials(opts: { url: string }): Promise<GithubCredentials>;
 }
 
+// @public
+export type GithubCredentialsProviderFactory = (
+  config: GitHubIntegrationConfig,
+) => GithubCredentialsProvider;
+
 // @public
 export type GithubCredentialType = 'app' | 'token';
 
@@ -433,6 +427,15 @@ export interface ScmIntegrationsGroup<T extends ScmIntegration> {
   list(): T[];
 }
 
+// @public
+export class SingleInstanceGithubCredentialsProvider
+  implements GithubCredentialsProvider
+{
+  // (undocumented)
+  static create: GithubCredentialsProviderFactory;
+  getCredentials(opts: { url: string }): Promise<GithubCredentials>;
+}
+
 // Warnings were encountered during analysis:
 //
 // src/gitlab/config.d.ts:29:68 - (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag

packages/integration/src/github/DefaultGithubCredentialsProvider.test.ts

@@ -31,11 +31,11 @@ jest.doMock('@octokit/rest', () => {
   return { Octokit };
 });
 
-import { DefaultGithubCredentialsProvider } from './DefaultGithubCredentialsProvider';
+import { SingleInstanceGithubCredentialsProvider } from './SingleInstanceGithubCredentialsProvider';
 import { RestEndpointMethodTypes } from '@octokit/rest';
 import { DateTime } from 'luxon';
 
-const github = DefaultGithubCredentialsProvider.create({
+const github = SingleInstanceGithubCredentialsProvider.create({
   host: 'github.com',
   apps: [
     {
@@ -204,7 +204,7 @@ describe('DefaultGithubCredentialsProvider tests', () => {
   });
 
   it('should return the default token if no app is configured', async () => {
-    const githubProvider = DefaultGithubCredentialsProvider.create({
+    const githubProvider = SingleInstanceGithubCredentialsProvider.create({
       host: 'github.com',
       apps: [],
       token: 'fallback_token',
@@ -218,7 +218,7 @@ describe('DefaultGithubCredentialsProvider tests', () => {
   });
 
   it('should return the configured token if there are no installations', async () => {
-    const githubProvider = DefaultGithubCredentialsProvider.create({
+    const githubProvider = SingleInstanceGithubCredentialsProvider.create({
       host: 'github.com',
       apps: [
         {
@@ -243,7 +243,7 @@ describe('DefaultGithubCredentialsProvider tests', () => {
   });
 
   it('should return undefined if no token or apps are configured', async () => {
-    const githubProvider = DefaultGithubCredentialsProvider.create({
+    const githubProvider = SingleInstanceGithubCredentialsProvider.create({
       host: 'github.com',
     });
 

packages/integration/src/github/SingleInstanceGithubCredentialsProvider.ts

@@ -22,6 +22,7 @@ import { DateTime } from 'luxon';
 import {
   GithubCredentials,
   GithubCredentialsProvider,
+  GithubCredentialsProviderFactory,
   GithubCredentialType,
 } from './types';
 
@@ -228,17 +229,15 @@ export class GithubAppCredentialsMux {
  *
  * TODO: Possibly move this to a backend only package so that it's not used in the frontend by mistake
  */
-export class DefaultGithubCredentialsProvider
+export class SingleInstanceGithubCredentialsProvider
   implements GithubCredentialsProvider
 {
-  static create(
-    config: GitHubIntegrationConfig,
-  ): DefaultGithubCredentialsProvider {
-    return new DefaultGithubCredentialsProvider(
+  static create: GithubCredentialsProviderFactory = config => {
+    return new SingleInstanceGithubCredentialsProvider(
       new GithubAppCredentialsMux(config),
       config.token,
     );
-  }
+  };
 
   private constructor(
     private readonly githubAppCredentialsMux: GithubAppCredentialsMux,

packages/integration/src/github/index.ts

@@ -22,11 +22,12 @@ export type { GithubAppConfig, GitHubIntegrationConfig } from './config';
 export { getGitHubFileFetchUrl, getGitHubRequestOptions } from './core';
 export {
   GithubAppCredentialsMux,
-  DefaultGithubCredentialsProvider,
-} from './DefaultGithubCredentialsProvider';
+  SingleInstanceGithubCredentialsProvider,
+} from './SingleInstanceGithubCredentialsProvider';
 export type {
   GithubCredentials,
   GithubCredentialsProvider,
+  GithubCredentialsProviderFactory,
   GithubCredentialType,
 } from './types';
 export { GitHubIntegration, replaceGitHubUrlType } from './GitHubIntegration';

packages/integration/src/github/types.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import { GitHubIntegrationConfig } from './config';
+
 /**
  * The type of credentials produced by the credential provider.
  *
@@ -41,3 +43,13 @@ export type GithubCredentials = {
 export interface GithubCredentialsProvider {
   getCredentials(opts: { url: string }): Promise<GithubCredentials>;
 }
+
+/**
+ * This allows implementations to provide factories to create credential providers
+ *
+ * @public
+ *
+ */
+export type GithubCredentialsProviderFactory = (
+  config: GitHubIntegrationConfig,
+) => GithubCredentialsProvider;