Allow Credential to auto-generate typings, separate internal vs external APIs

src/credential/credential-internal.ts

@@ -19,7 +19,7 @@ import fs = require('fs');
 import os = require('os');
 import path = require('path');
 
-import { GoogleOAuthAccessToken, Credential } from './credential';
+import { GoogleOAuthAccessToken, Credential } from './google-oauth-access-token';
 import { AppErrorCodes, FirebaseAppError } from '../utils/error';
 import { HttpClient, HttpRequestConfig, HttpError, HttpResponse } from '../utils/api-request';
 import { Agent } from 'http';

src/credential/credential.ts

@@ -19,44 +19,12 @@ import { Agent } from 'http';
 import {
   ServiceAccountCredential, RefreshTokenCredential, getApplicationDefault 
 } from './credential-internal';
+import { Credential } from './google-oauth-access-token';
 
 let globalAppDefaultCred: Credential;
 const globalCertCreds: { [key: string]: ServiceAccountCredential } = {};
 const globalRefreshTokenCreds: { [key: string]: RefreshTokenCredential } = {};
 
-/**
- * Interface for Google OAuth 2.0 access tokens.
- */
-export interface GoogleOAuthAccessToken {
-  /* tslint:disable:variable-name */
-  access_token: string;
-  expires_in: number;
-  /* tslint:enable:variable-name */
-}
-
-/**
- * Interface that provides Google OAuth2 access tokens used to authenticate
- * with Firebase services.
- *
- * In most cases, you will not need to implement this yourself and can instead
- * use the default implementations provided by
- * {@link admin.credential `admin.credential`}.
- */
-export interface Credential {
-  /**
-   * Returns a Google OAuth2 access token object used to authenticate with
-   * Firebase services.
-   *
-   * This object contains the following properties:
-   * * `access_token` (`string`): The actual Google OAuth2 access token.
-   * * `expires_in` (`number`): The number of seconds from when the token was
-   *   issued that it expires.
-   *
-   * @return A Google OAuth2 access token object.
-   */
-  getAccessToken(): Promise<GoogleOAuthAccessToken>;
-}
-
 /**
  * Returns a credential created from the
  * {@link

src/credential/google-oauth-access-token.ts

@@ -0,0 +1,48 @@
+/*!
+ * Copyright 2020 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Interface for Google OAuth 2.0 access tokens.
+ */
+export interface GoogleOAuthAccessToken {
+  /* tslint:disable:variable-name */
+  access_token: string;
+  expires_in: number;
+  /* tslint:enable:variable-name */
+}
+
+/**
+ * Interface that provides Google OAuth2 access tokens used to authenticate
+ * with Firebase services.
+ *
+ * In most cases, you will not need to implement this yourself and can instead
+ * use the default implementations provided by
+ * {@link admin.credential `admin.credential`}.
+ */
+export interface Credential {
+  /**
+   * Returns a Google OAuth2 access token object used to authenticate with
+   * Firebase services.
+   *
+   * This object contains the following properties:
+   * * `access_token` (`string`): The actual Google OAuth2 access token.
+   * * `expires_in` (`number`): The number of seconds from when the token was
+   *   issued that it expires.
+   *
+   * @return A Google OAuth2 access token object.
+   */
+  getAccessToken(): Promise<GoogleOAuthAccessToken>;
+}

src/credential/index.ts

@@ -15,6 +15,7 @@
  */
 
 import * as credentialApi from './credential';
+import * as googleOauthAccessTokenApi from './google-oauth-access-token';
 
 /**
  * Temporarily, admin.credential is used as the namespace name because we
@@ -28,7 +29,7 @@ export namespace admin.credential {
   // See https://github.com/typescript-eslint/typescript-eslint/issues/363
   // Allows for exposing classes as interfaces in typings
   /* eslint-disable @typescript-eslint/no-empty-interface */
-  export import Credential = credentialApi.Credential;
+  export import Credential = googleOauthAccessTokenApi.Credential;
   export const applicationDefault = credentialApi.applicationDefault;
   export const cert = credentialApi.cert;
   export const refreshToken = credentialApi.refreshToken;

src/firebase-app.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { Credential, GoogleOAuthAccessToken } from './credential/credential';
+import { Credential, GoogleOAuthAccessToken } from './credential/google-oauth-access-token';
 import { getApplicationDefault } from './credential/credential-internal';
 import * as validator from './utils/validator';
 import { deepCopy, deepExtend } from './utils/deep-copy';

test/integration/setup.ts

@@ -19,7 +19,7 @@ import fs = require('fs');
 import minimist = require('minimist');
 import path = require('path');
 import { random } from 'lodash';
-import { Credential, GoogleOAuthAccessToken } from '../../src/credential/credential';
+import { Credential, GoogleOAuthAccessToken } from '../../src/credential/google-oauth-access-token';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const chalk = require('chalk');

test/resources/mocks.ts

@@ -27,7 +27,7 @@ import * as jwt from 'jsonwebtoken';
 import { FirebaseNamespace } from '../../src/firebase-namespace';
 import { FirebaseServiceInterface } from '../../src/firebase-service';
 import { FirebaseApp, FirebaseAppOptions } from '../../src/firebase-app';
-import { Credential, GoogleOAuthAccessToken } from '../../src/credential/credential';
+import { Credential, GoogleOAuthAccessToken } from '../../src/credential/google-oauth-access-token';
 import { ServiceAccountCredential } from '../../src/credential/credential-internal';
 
 const ALGORITHM = 'RS256';

test/unit/credential/credential.spec.ts

@@ -32,7 +32,7 @@ import * as mocks from '../../resources/mocks';
 
 import {
   GoogleOAuthAccessToken, Credential
-} from '../../../src/credential/credential';
+} from '../../../src/credential/google-oauth-access-token';
 import {
   RefreshTokenCredential, ServiceAccountCredential,
   ComputeEngineCredential, getApplicationDefault, isApplicationDefault

test/unit/firebase-app.spec.ts

@@ -25,7 +25,7 @@ import * as chaiAsPromised from 'chai-as-promised';
 import * as utils from './utils';
 import * as mocks from '../resources/mocks';
 
-import { GoogleOAuthAccessToken } from '../../src/credential/credential';
+import { GoogleOAuthAccessToken } from '../../src/credential/google-oauth-access-token';
 import { ServiceAccountCredential } from '../../src/credential/credential-internal';
 import { FirebaseServiceInterface } from '../../src/firebase-service';
 import { FirebaseApp, FirebaseAccessToken } from '../../src/firebase-app';