Fix a bunch of little issues with the new auth API (#3999)

* Bunch of signature updates for auth

* Auth docs

* Formatting

* Add small redirect fix

* Fixes

* Revert markdown files since the docgen tool isn't working

* Fix broken stuff

* Formatting

Author: sam-gc

common/api-review/auth-exp.api.md

@@ -29,7 +29,7 @@ export class ActionCodeURL implements externs.ActionCodeURL {
     // (undocumented)
     readonly languageCode: string | null;
     // (undocumented)
-    readonly operation: externs.Operation;
+    readonly operation: externs.ActionCodeOperation;
     // (undocumented)
     static parseLink(link: string): externs.ActionCodeURL | null;
     // (undocumented)

docs-exp/auth-types.actioncodeoperation.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/auth-types](./auth-types.md) &gt; [ActionCodeOperation](./auth-types.actioncodeoperation.md)
+
+## ActionCodeOperation enum
+
+An enumeration of the possible email action types.
+
+<b>Signature:</b>
+
+```typescript
+export const enum ActionCodeOperation 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  EMAIL\_SIGNIN | <code>'EMAIL_SIGNIN'</code> | The email link sign-in action. |
+|  PASSWORD\_RESET | <code>'PASSWORD_RESET'</code> | The password reset action. |
+|  RECOVER\_EMAIL | <code>'RECOVER_EMAIL'</code> | The email revocation action. |
+|  REVERT\_SECOND\_FACTOR\_ADDITION | <code>'REVERT_SECOND_FACTOR_ADDITION'</code> | The revert second factor addition email action. |
+|  VERIFY\_AND\_CHANGE\_EMAIL | <code>'VERIFY_AND_CHANGE_EMAIL'</code> | The revert second factor addition email action. |
+|  VERIFY\_EMAIL | <code>'VERIFY_EMAIL'</code> | The email verification action. |
+

packages-exp/auth-compat-exp/index.ts

@@ -51,13 +51,14 @@ function registerAuthCompat(instance: _FirebaseNamespace): void {
       .setServiceProps({
         ActionCodeInfo: {
           Operation: {
-            EMAIL_SIGNIN: externs.Operation.EMAIL_SIGNIN,
-            PASSWORD_RESET: externs.Operation.PASSWORD_RESET,
-            RECOVER_EMAIL: externs.Operation.RECOVER_EMAIL,
+            EMAIL_SIGNIN: externs.ActionCodeOperation.EMAIL_SIGNIN,
+            PASSWORD_RESET: externs.ActionCodeOperation.PASSWORD_RESET,
+            RECOVER_EMAIL: externs.ActionCodeOperation.RECOVER_EMAIL,
             REVERT_SECOND_FACTOR_ADDITION:
-              externs.Operation.REVERT_SECOND_FACTOR_ADDITION,
-            VERIFY_AND_CHANGE_EMAIL: externs.Operation.VERIFY_AND_CHANGE_EMAIL,
-            VERIFY_EMAIL: externs.Operation.VERIFY_EMAIL
+              externs.ActionCodeOperation.REVERT_SECOND_FACTOR_ADDITION,
+            VERIFY_AND_CHANGE_EMAIL:
+              externs.ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
+            VERIFY_EMAIL: externs.ActionCodeOperation.VERIFY_EMAIL
           }
         },
         EmailAuthProvider: impl.EmailAuthProvider,

packages-exp/auth-exp/demo/.gitignore

@@ -1,5 +1,6 @@
 src/config.js
 .firebaserc
+.firebase
 public/service-worker.*
 public/web-worker.*
 public/index.js*

packages-exp/auth-exp/src/api/account_management/email_and_password.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { Operation, Auth } from '@firebase/auth-types-exp';
+import { ActionCodeOperation, Auth } from '@firebase/auth-types-exp';
 
 import { Endpoint, HttpMethod, _performApiRequest } from '../index';
 import { IdTokenResponse } from '../../model/id_token';
@@ -29,7 +29,7 @@ export interface ResetPasswordRequest {
 export interface ResetPasswordResponse {
   email: string;
   newEmail?: string;
-  requestType?: Operation;
+  requestType?: ActionCodeOperation;
   mfaInfo?: MfaEnrollment;
 }
 

packages-exp/auth-exp/src/api/authentication/email_and_password.test.ts

@@ -18,7 +18,7 @@
 import { expect, use } from 'chai';
 import * as chaiAsPromised from 'chai-as-promised';
 
-import { Operation } from '@firebase/auth-types-exp';
+import { ActionCodeOperation } from '@firebase/auth-types-exp';
 import { FirebaseError } from '@firebase/util';
 
 import { Endpoint, HttpHeader } from '../';
@@ -102,7 +102,7 @@ describe('api/authentication/signInWithPassword', () => {
 
 describe('api/authentication/sendEmailVerification', () => {
   const request: VerifyEmailRequest = {
-    requestType: Operation.VERIFY_EMAIL,
+    requestType: ActionCodeOperation.VERIFY_EMAIL,
     idToken: 'my-token'
   };
 
@@ -159,7 +159,7 @@ describe('api/authentication/sendEmailVerification', () => {
 
 describe('api/authentication/sendPasswordResetEmail', () => {
   const request: PasswordResetRequest = {
-    requestType: Operation.PASSWORD_RESET,
+    requestType: ActionCodeOperation.PASSWORD_RESET,
     email: '[email protected]'
   };
 
@@ -216,7 +216,7 @@ describe('api/authentication/sendPasswordResetEmail', () => {
 
 describe('api/authentication/sendSignInLinkToEmail', () => {
   const request: EmailSignInRequest = {
-    requestType: Operation.EMAIL_SIGNIN,
+    requestType: ActionCodeOperation.EMAIL_SIGNIN,
     email: '[email protected]'
   };
 
@@ -273,7 +273,7 @@ describe('api/authentication/sendSignInLinkToEmail', () => {
 
 describe('api/authentication/verifyAndChangeEmail', () => {
   const request: VerifyAndChangeEmailRequest = {
-    requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
+    requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
     idToken: 'id-token',
     newEmail: '[email protected]'
   };

packages-exp/auth-exp/src/api/authentication/email_and_password.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { Operation, Auth } from '@firebase/auth-types-exp';
+import { ActionCodeOperation, Auth } from '@firebase/auth-types-exp';
 
 import {
   Endpoint,
@@ -61,23 +61,23 @@ export interface GetOobCodeRequest {
 }
 
 export interface VerifyEmailRequest extends GetOobCodeRequest {
-  requestType: Operation.VERIFY_EMAIL;
+  requestType: ActionCodeOperation.VERIFY_EMAIL;
   idToken: IdToken;
 }
 
 export interface PasswordResetRequest extends GetOobCodeRequest {
-  requestType: Operation.PASSWORD_RESET;
+  requestType: ActionCodeOperation.PASSWORD_RESET;
   email: string;
   captchaResp?: string;
 }
 
 export interface EmailSignInRequest extends GetOobCodeRequest {
-  requestType: Operation.EMAIL_SIGNIN;
+  requestType: ActionCodeOperation.EMAIL_SIGNIN;
   email: string;
 }
 
 export interface VerifyAndChangeEmailRequest extends GetOobCodeRequest {
-  requestType: Operation.VERIFY_AND_CHANGE_EMAIL;
+  requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL;
   idToken: IdToken;
   newEmail: string;
 }

packages-exp/auth-exp/src/core/action_code_url.test.ts

@@ -17,7 +17,7 @@
 
 import { expect } from 'chai';
 
-import { Operation } from '@firebase/auth-types-exp';
+import { ActionCodeOperation } from '@firebase/auth-types-exp';
 
 import { ActionCodeURL } from './action_code_url';
 
@@ -32,7 +32,7 @@ describe('core/action_code_url', () => {
         encodeURIComponent(continueUrl) +
         '&languageCode=en&tenantId=TENANT_ID&state=bla';
       const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
-      expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
+      expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.EMAIL_SIGNIN);
       expect(actionCodeUrl!.code).to.eq('CODE');
       expect(actionCodeUrl!.apiKey).to.eq('API_KEY');
       // ContinueUrl should be decoded.
@@ -48,7 +48,9 @@ describe('core/action_code_url', () => {
           'oobCode=CODE&mode=signIn&apiKey=API_KEY&' +
           'languageCode=en';
         const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
-        expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
+        expect(actionCodeUrl!.operation).to.eq(
+          ActionCodeOperation.EMAIL_SIGNIN
+        );
       });
 
       it('should identitfy VERIFY_AND_CHANGE_EMAIL', () => {
@@ -58,7 +60,7 @@ describe('core/action_code_url', () => {
           'languageCode=en';
         const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
         expect(actionCodeUrl!.operation).to.eq(
-          Operation.VERIFY_AND_CHANGE_EMAIL
+          ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL
         );
       });
 
@@ -68,7 +70,9 @@ describe('core/action_code_url', () => {
           'oobCode=CODE&mode=verifyEmail&apiKey=API_KEY&' +
           'languageCode=en';
         const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
-        expect(actionCodeUrl!.operation).to.eq(Operation.VERIFY_EMAIL);
+        expect(actionCodeUrl!.operation).to.eq(
+          ActionCodeOperation.VERIFY_EMAIL
+        );
       });
 
       it('should identitfy RECOVER_EMAIL', () => {
@@ -77,7 +81,9 @@ describe('core/action_code_url', () => {
           'oobCode=CODE&mode=recoverEmail&apiKey=API_KEY&' +
           'languageCode=en';
         const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
-        expect(actionCodeUrl!.operation).to.eq(Operation.RECOVER_EMAIL);
+        expect(actionCodeUrl!.operation).to.eq(
+          ActionCodeOperation.RECOVER_EMAIL
+        );
       });
 
       it('should identitfy PASSWORD_RESET', () => {
@@ -86,7 +92,9 @@ describe('core/action_code_url', () => {
           'oobCode=CODE&mode=resetPassword&apiKey=API_KEY&' +
           'languageCode=en';
         const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
-        expect(actionCodeUrl!.operation).to.eq(Operation.PASSWORD_RESET);
+        expect(actionCodeUrl!.operation).to.eq(
+          ActionCodeOperation.PASSWORD_RESET
+        );
       });
 
       it('should identitfy REVERT_SECOND_FACTOR_ADDITION', () => {
@@ -96,7 +104,7 @@ describe('core/action_code_url', () => {
           'languageCode=en';
         const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
         expect(actionCodeUrl!.operation).to.eq(
-          Operation.REVERT_SECOND_FACTOR_ADDITION
+          ActionCodeOperation.REVERT_SECOND_FACTOR_ADDITION
         );
       });
     });
@@ -106,7 +114,7 @@ describe('core/action_code_url', () => {
         'https://www.example.com:8080/finishSignIn?' +
         'oobCode=CODE&mode=signIn&apiKey=API_KEY&state=bla';
       const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
-      expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
+      expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.EMAIL_SIGNIN);
       expect(actionCodeUrl!.code).to.eq('CODE');
       expect(actionCodeUrl!.apiKey).to.eq('API_KEY');
       expect(actionCodeUrl!.continueUrl).to.be.null;
@@ -120,7 +128,7 @@ describe('core/action_code_url', () => {
         'oobCode=CODE1&mode=signIn&apiKey=API_KEY1&state=bla' +
         '#oobCode=CODE2&mode=signIn&apiKey=API_KEY2&state=bla';
       const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
-      expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
+      expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.EMAIL_SIGNIN);
       expect(actionCodeUrl!.code).to.eq('CODE1');
       expect(actionCodeUrl!.apiKey).to.eq('API_KEY1');
       expect(actionCodeUrl!.continueUrl).to.be.null;

packages-exp/auth-exp/src/core/action_code_url.ts

@@ -40,20 +40,20 @@ const enum QueryField {
  * @param mode
  * @internal
  */
-function parseMode(mode: string | null): externs.Operation | null {
+function parseMode(mode: string | null): externs.ActionCodeOperation | null {
   switch (mode) {
     case 'recoverEmail':
-      return externs.Operation.RECOVER_EMAIL;
+      return externs.ActionCodeOperation.RECOVER_EMAIL;
     case 'resetPassword':
-      return externs.Operation.PASSWORD_RESET;
+      return externs.ActionCodeOperation.PASSWORD_RESET;
     case 'signIn':
-      return externs.Operation.EMAIL_SIGNIN;
+      return externs.ActionCodeOperation.EMAIL_SIGNIN;
     case 'verifyEmail':
-      return externs.Operation.VERIFY_EMAIL;
+      return externs.ActionCodeOperation.VERIFY_EMAIL;
     case 'verifyAndChangeEmail':
-      return externs.Operation.VERIFY_AND_CHANGE_EMAIL;
+      return externs.ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL;
     case 'revertSecondFactorAddition':
-      return externs.Operation.REVERT_SECOND_FACTOR_ADDITION;
+      return externs.ActionCodeOperation.REVERT_SECOND_FACTOR_ADDITION;
     default:
       return null;
   }
@@ -93,7 +93,7 @@ export class ActionCodeURL implements externs.ActionCodeURL {
   /** {@inheritDoc @firebase/auth-types#ActionCodeURL.languageCode} */
   readonly languageCode: string | null;
   /** {@inheritDoc @firebase/auth-types#ActionCodeURL.operation} */
-  readonly operation: externs.Operation;
+  readonly operation: externs.ActionCodeOperation;
   /** {@inheritDoc @firebase/auth-types#ActionCodeURL.tenantId} */
   readonly tenantId: string | null;
 

packages-exp/auth-exp/src/core/strategies/credential.test.ts

@@ -144,7 +144,6 @@ describe('core/strategies/credential', () => {
       const error = await expect(
         signInWithCredential(auth, authCredential)
       ).to.be.rejectedWith(MultiFactorError);
-      expect(error.credential).to.eq(authCredential);
       expect(error.operationType).to.eq(OperationType.SIGN_IN);
       expect(error.serverResponse).to.eql(serverResponse);
       expect(error.user).to.be.undefined;