chore: linting

Author: boikoa-gl

etc/firebase-admin.fpnv.api.md

@@ -6,55 +6,28 @@
 
 import { Agent } from 'http';
 
-// Warning: (ae-forgotten-export) The symbol "PrefixedFirebaseError" needs to be exported by the entry point index.d.ts
-//
-// @public
-export class FirebasePnvError extends PrefixedFirebaseError {
-}
-
 // @public
 export class Fpnv {
     // Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
-    constructor(app: App);
     get app(): App;
     // Warning: (ae-forgotten-export) The symbol "FirebasePhoneNumberTokenVerifier" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
     protected readonly fpnvVerifier: FirebasePhoneNumberTokenVerifier;
     // (undocumented)
-    verifyToken(idToken: string): Promise<FpnvToken>;
-}
-
-// @public (undocumented)
-export class FpnvErrorCode {
-    // (undocumented)
-    static readonly EXPIRED_TOKEN: ErrorInfo;
-    // Warning: (ae-forgotten-export) The symbol "ErrorInfo" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    static readonly INVALID_ARGUMENT: ErrorInfo;
-    // (undocumented)
-    static readonly INVALID_TOKEN: ErrorInfo;
-    // (undocumented)
-    static readonly PROJECT_NOT_FOUND: ErrorInfo;
+    verifyToken(fpnvJwt: string): Promise<FpnvToken>;
 }
 
 // @public
 export interface FpnvToken {
     [key: string]: any;
-    // (undocumented)
-    aud: string;
-    // (undocumented)
-    auth_time: number;
-    // (undocumented)
+    aud: string[];
     exp: number;
-    // (undocumented)
     getPhoneNumber(): string;
-    // (undocumented)
     iat: number;
-    // (undocumented)
     iss: string;
-    // (undocumented)
+    jti: string;
+    nonce: string;
     sub: string;
 }
 

src/fpnv/fpnv-api-client-internal.ts

@@ -58,14 +58,14 @@ export type FpnvErrorCode =
  * @param message - The error message.
  * @constructor
  */
-export class FirebasePnvError extends PrefixedFirebaseError {
+export class FirebaseFpnvError extends PrefixedFirebaseError {
   constructor(code: FpnvErrorCode, message: string) {
     super('fpnv', code, message);
 
     /* tslint:disable:max-line-length */
     // Set the prototype explicitly. See the following link for more details:
     // https://github.com/Microsoft/TypeScript/wiki/Breaking-Changes#extending-built-ins-like-error-array-and-map-may-no-longer-work
     /* tslint:enable:max-line-length */
-    (this as any).__proto__ = FirebasePnvError.prototype;
+    (this as any).__proto__ = FirebaseFpnvError.prototype;
   }
 }

src/fpnv/fpnv-api.ts

@@ -24,7 +24,7 @@ export interface FpnvToken {
      * The issuer identifier for the issuer of the response.
      * This value is a URL with the format
      * `https://firebaseappcheck.googleapis.com/<PROJECT_NUMBER>`, where `<PROJECT_NUMBER>` is the
-     * same project number specified in the {@link aud} property.
+     * same project number specified in the {@link FpnvToken.aud} property.
      */
     iss: string;
 
@@ -66,7 +66,7 @@ export interface FpnvToken {
     /**
      * The corresponding user's phone number.
      * This value is not actually one of the JWT token claims. It is added as a
-     * convenience, and is set as the value of the {@link sub} property.
+     * convenience, and is set as the value of the {@link FpnvToken.sub} property.
      */
     getPhoneNumber(): string;
 
@@ -76,5 +76,5 @@ export interface FpnvToken {
     [key: string]: any;
 }
 
-export { FpnvErrorCode, FirebasePnvError } from './fpnv-api-client-internal';
+export { FpnvErrorCode, FirebaseFpnvError } from './fpnv-api-client-internal';
 

src/fpnv/index.ts

@@ -31,8 +31,6 @@ export {
 
 export {
   FpnvToken,
-  FirebasePnvError,
-  FpnvErrorCode,
 } from './fpnv-api'
 
 /**

src/fpnv/token-verifier.ts

@@ -16,7 +16,7 @@
  */
 
 import { App } from '../app';
-import { FirebasePnvError, FpnvToken } from './fpnv-api';
+import { FirebaseFpnvError, FpnvToken } from './fpnv-api';
 import * as util from '../utils/index';
 import * as validator from '../utils/validator';
 import {
@@ -38,37 +38,37 @@ export class FirebasePhoneNumberTokenVerifier {
   ) {
 
     if (!validator.isURL(clientCertUrl)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'The provided public client certificate URL is an invalid URL.',
       );
     } else if (!validator.isURL(issuer)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'The provided JWT issuer is an invalid URL.',
       );
     } else if (!validator.isNonNullObject(tokenInfo)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'The provided JWT information is not an object or null.',
       );
     } else if (!validator.isURL(tokenInfo.url)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'The provided JWT verification documentation URL is invalid.',
       );
     } else if (!validator.isNonEmptyString(tokenInfo.verifyApiName)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'The JWT verify API name must be a non-empty string.',
       );
     } else if (!validator.isNonEmptyString(tokenInfo.jwtName)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'The JWT public full name must be a non-empty string.',
       );
     } else if (!validator.isNonEmptyString(tokenInfo.shortName)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'The JWT public short name must be a non-empty string.',
       );
@@ -83,7 +83,7 @@ export class FirebasePhoneNumberTokenVerifier {
 
   public async verifyJWT(jwtToken: string): Promise<FpnvToken> {
     if (!validator.isString(jwtToken)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_TOKEN,
         `First argument to ${this.tokenInfo.verifyApiName} must be a string.`,
       );
@@ -99,7 +99,7 @@ export class FirebasePhoneNumberTokenVerifier {
   private async ensureProjectId(): Promise<string> {
     const projectId = await util.findProjectId(this.app);
     if (!validator.isNonEmptyString(projectId)) {
-      throw new FirebasePnvError(
+      throw new FirebaseFpnvError(
         FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
         'Must initialize app with a cert credential or set your Firebase project ID as the ' +
                 `GOOGLE_CLOUD_PROJECT environment variable to call ${this.tokenInfo.verifyApiName}.`);
@@ -127,10 +127,10 @@ export class FirebasePhoneNumberTokenVerifier {
         const errorMessage = `Decoding ${this.tokenInfo.jwtName} failed. Make sure you passed ` +
                     `the entire string JWT which represents ${this.shortNameArticle} ` +
                     `${this.tokenInfo.shortName}.` + verifyJwtTokenDocsMessage;
-        throw new FirebasePnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
+        throw new FirebaseFpnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT,
           errorMessage);
       }
-      throw new FirebasePnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, err.message);
+      throw new FirebaseFpnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, err.message);
     }
   }
 
@@ -171,7 +171,7 @@ export class FirebasePhoneNumberTokenVerifier {
     }
 
     if (errorMessage) {
-      throw new FirebasePnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, errorMessage);
+      throw new FirebaseFpnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, errorMessage);
     }
   }
 
@@ -189,17 +189,17 @@ export class FirebasePhoneNumberTokenVerifier {
     if (error.code === JwtErrorCode.TOKEN_EXPIRED) {
       const errorMessage = `${this.tokenInfo.jwtName} has expired. Get a fresh ${this.tokenInfo.shortName}` +
                 ` from your client app and try again. ${verifyJwtTokenDocsMessage}`;
-      return new FirebasePnvError(FPNV_ERROR_CODE_MAPPING.EXPIRED_TOKEN, errorMessage);
+      return new FirebaseFpnvError(FPNV_ERROR_CODE_MAPPING.EXPIRED_TOKEN, errorMessage);
     } else if (error.code === JwtErrorCode.INVALID_SIGNATURE) {
       const errorMessage = `${this.tokenInfo.jwtName} has invalid signature. ${verifyJwtTokenDocsMessage}`;
-      return new FirebasePnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, errorMessage);
+      return new FirebaseFpnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, errorMessage);
     } else if (error.code === JwtErrorCode.NO_MATCHING_KID) {
       const errorMessage = `${this.tokenInfo.jwtName} has "kid" claim which does not ` +
                 `correspond to a known public key. Most likely the ${this.tokenInfo.shortName} ` +
                 'is expired, so get a fresh token from your client app and try again.';
-      return new FirebasePnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, errorMessage);
+      return new FirebaseFpnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, errorMessage);
     }
-    return new FirebasePnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, error.message);
+    return new FirebaseFpnvError(FPNV_ERROR_CODE_MAPPING.INVALID_ARGUMENT, error.message);
   }
 
 }