Skip to content

Commit 8939cd4

Browse files
sam-gcsam-gc
committed
Bunch of signature updates for auth
1 parent f2562c2 commit 8939cd4

23 files changed

+109
-114
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export class ActionCodeURL implements externs.ActionCodeURL {
2929
// (undocumented)
3030
readonly languageCode: string | null;
3131
// (undocumented)
32-
readonly operation: externs.Operation;
32+
readonly operation: externs.ActionCodeOperation;
3333
// (undocumented)
3434
static parseLink(link: string): externs.ActionCodeURL | null;
3535
// (undocumented)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
import { Operation, Auth } from '@firebase/auth-types-exp';
18+
import { ActionCodeOperation, Auth } from '@firebase/auth-types-exp';
1919

2020
import { Endpoint, HttpMethod, _performApiRequest } from '../index';
2121
import { IdTokenResponse } from '../../model/id_token';
@@ -29,7 +29,7 @@ export interface ResetPasswordRequest {
2929
export interface ResetPasswordResponse {
3030
email: string;
3131
newEmail?: string;
32-
requestType?: Operation;
32+
requestType?: ActionCodeOperation;
3333
mfaInfo?: MfaEnrollment;
3434
}
3535

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import { expect, use } from 'chai';
1919
import * as chaiAsPromised from 'chai-as-promised';
2020

21-
import { Operation } from '@firebase/auth-types-exp';
21+
import { ActionCodeOperation } from '@firebase/auth-types-exp';
2222
import { FirebaseError } from '@firebase/util';
2323

2424
import { Endpoint, HttpHeader } from '../';
@@ -102,7 +102,7 @@ describe('api/authentication/signInWithPassword', () => {
102102

103103
describe('api/authentication/sendEmailVerification', () => {
104104
const request: VerifyEmailRequest = {
105-
requestType: Operation.VERIFY_EMAIL,
105+
requestType: ActionCodeOperation.VERIFY_EMAIL,
106106
idToken: 'my-token'
107107
};
108108

@@ -159,7 +159,7 @@ describe('api/authentication/sendEmailVerification', () => {
159159

160160
describe('api/authentication/sendPasswordResetEmail', () => {
161161
const request: PasswordResetRequest = {
162-
requestType: Operation.PASSWORD_RESET,
162+
requestType: ActionCodeOperation.PASSWORD_RESET,
163163
email: '[email protected]'
164164
};
165165

@@ -216,7 +216,7 @@ describe('api/authentication/sendPasswordResetEmail', () => {
216216

217217
describe('api/authentication/sendSignInLinkToEmail', () => {
218218
const request: EmailSignInRequest = {
219-
requestType: Operation.EMAIL_SIGNIN,
219+
requestType: ActionCodeOperation.EMAIL_SIGNIN,
220220
email: '[email protected]'
221221
};
222222

@@ -273,7 +273,7 @@ describe('api/authentication/sendSignInLinkToEmail', () => {
273273

274274
describe('api/authentication/verifyAndChangeEmail', () => {
275275
const request: VerifyAndChangeEmailRequest = {
276-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
276+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
277277
idToken: 'id-token',
278278
newEmail: '[email protected]'
279279
};

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
import { Operation, Auth } from '@firebase/auth-types-exp';
18+
import { ActionCodeOperation, Auth } from '@firebase/auth-types-exp';
1919

2020
import {
2121
Endpoint,
@@ -61,23 +61,23 @@ export interface GetOobCodeRequest {
6161
}
6262

6363
export interface VerifyEmailRequest extends GetOobCodeRequest {
64-
requestType: Operation.VERIFY_EMAIL;
64+
requestType: ActionCodeOperation.VERIFY_EMAIL;
6565
idToken: IdToken;
6666
}
6767

6868
export interface PasswordResetRequest extends GetOobCodeRequest {
69-
requestType: Operation.PASSWORD_RESET;
69+
requestType: ActionCodeOperation.PASSWORD_RESET;
7070
email: string;
7171
captchaResp?: string;
7272
}
7373

7474
export interface EmailSignInRequest extends GetOobCodeRequest {
75-
requestType: Operation.EMAIL_SIGNIN;
75+
requestType: ActionCodeOperation.EMAIL_SIGNIN;
7676
email: string;
7777
}
7878

7979
export interface VerifyAndChangeEmailRequest extends GetOobCodeRequest {
80-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL;
80+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL;
8181
idToken: IdToken;
8282
newEmail: string;
8383
}

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import { expect } from 'chai';
1919

20-
import { Operation } from '@firebase/auth-types-exp';
20+
import { ActionCodeOperation } from '@firebase/auth-types-exp';
2121

2222
import { ActionCodeURL } from './action_code_url';
2323

@@ -32,7 +32,7 @@ describe('core/action_code_url', () => {
3232
encodeURIComponent(continueUrl) +
3333
'&languageCode=en&tenantId=TENANT_ID&state=bla';
3434
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
35-
expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
35+
expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.EMAIL_SIGNIN);
3636
expect(actionCodeUrl!.code).to.eq('CODE');
3737
expect(actionCodeUrl!.apiKey).to.eq('API_KEY');
3838
// ContinueUrl should be decoded.
@@ -48,7 +48,7 @@ describe('core/action_code_url', () => {
4848
'oobCode=CODE&mode=signIn&apiKey=API_KEY&' +
4949
'languageCode=en';
5050
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
51-
expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
51+
expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.EMAIL_SIGNIN);
5252
});
5353

5454
it('should identitfy VERIFY_AND_CHANGE_EMAIL', () => {
@@ -58,7 +58,7 @@ describe('core/action_code_url', () => {
5858
'languageCode=en';
5959
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
6060
expect(actionCodeUrl!.operation).to.eq(
61-
Operation.VERIFY_AND_CHANGE_EMAIL
61+
ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL
6262
);
6363
});
6464

@@ -68,7 +68,7 @@ describe('core/action_code_url', () => {
6868
'oobCode=CODE&mode=verifyEmail&apiKey=API_KEY&' +
6969
'languageCode=en';
7070
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
71-
expect(actionCodeUrl!.operation).to.eq(Operation.VERIFY_EMAIL);
71+
expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.VERIFY_EMAIL);
7272
});
7373

7474
it('should identitfy RECOVER_EMAIL', () => {
@@ -77,7 +77,7 @@ describe('core/action_code_url', () => {
7777
'oobCode=CODE&mode=recoverEmail&apiKey=API_KEY&' +
7878
'languageCode=en';
7979
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
80-
expect(actionCodeUrl!.operation).to.eq(Operation.RECOVER_EMAIL);
80+
expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.RECOVER_EMAIL);
8181
});
8282

8383
it('should identitfy PASSWORD_RESET', () => {
@@ -86,7 +86,7 @@ describe('core/action_code_url', () => {
8686
'oobCode=CODE&mode=resetPassword&apiKey=API_KEY&' +
8787
'languageCode=en';
8888
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
89-
expect(actionCodeUrl!.operation).to.eq(Operation.PASSWORD_RESET);
89+
expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.PASSWORD_RESET);
9090
});
9191

9292
it('should identitfy REVERT_SECOND_FACTOR_ADDITION', () => {
@@ -96,7 +96,7 @@ describe('core/action_code_url', () => {
9696
'languageCode=en';
9797
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
9898
expect(actionCodeUrl!.operation).to.eq(
99-
Operation.REVERT_SECOND_FACTOR_ADDITION
99+
ActionCodeOperation.REVERT_SECOND_FACTOR_ADDITION
100100
);
101101
});
102102
});
@@ -106,7 +106,7 @@ describe('core/action_code_url', () => {
106106
'https://www.example.com:8080/finishSignIn?' +
107107
'oobCode=CODE&mode=signIn&apiKey=API_KEY&state=bla';
108108
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
109-
expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
109+
expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.EMAIL_SIGNIN);
110110
expect(actionCodeUrl!.code).to.eq('CODE');
111111
expect(actionCodeUrl!.apiKey).to.eq('API_KEY');
112112
expect(actionCodeUrl!.continueUrl).to.be.null;
@@ -120,7 +120,7 @@ describe('core/action_code_url', () => {
120120
'oobCode=CODE1&mode=signIn&apiKey=API_KEY1&state=bla' +
121121
'#oobCode=CODE2&mode=signIn&apiKey=API_KEY2&state=bla';
122122
const actionCodeUrl = ActionCodeURL.parseLink(actionLink);
123-
expect(actionCodeUrl!.operation).to.eq(Operation.EMAIL_SIGNIN);
123+
expect(actionCodeUrl!.operation).to.eq(ActionCodeOperation.EMAIL_SIGNIN);
124124
expect(actionCodeUrl!.code).to.eq('CODE1');
125125
expect(actionCodeUrl!.apiKey).to.eq('API_KEY1');
126126
expect(actionCodeUrl!.continueUrl).to.be.null;

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,20 @@ const enum QueryField {
4040
* @param mode
4141
* @internal
4242
*/
43-
function parseMode(mode: string | null): externs.Operation | null {
43+
function parseMode(mode: string | null): externs.ActionCodeOperation | null {
4444
switch (mode) {
4545
case 'recoverEmail':
46-
return externs.Operation.RECOVER_EMAIL;
46+
return externs.ActionCodeOperation.RECOVER_EMAIL;
4747
case 'resetPassword':
48-
return externs.Operation.PASSWORD_RESET;
48+
return externs.ActionCodeOperation.PASSWORD_RESET;
4949
case 'signIn':
50-
return externs.Operation.EMAIL_SIGNIN;
50+
return externs.ActionCodeOperation.EMAIL_SIGNIN;
5151
case 'verifyEmail':
52-
return externs.Operation.VERIFY_EMAIL;
52+
return externs.ActionCodeOperation.VERIFY_EMAIL;
5353
case 'verifyAndChangeEmail':
54-
return externs.Operation.VERIFY_AND_CHANGE_EMAIL;
54+
return externs.ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL;
5555
case 'revertSecondFactorAddition':
56-
return externs.Operation.REVERT_SECOND_FACTOR_ADDITION;
56+
return externs.ActionCodeOperation.REVERT_SECOND_FACTOR_ADDITION;
5757
default:
5858
return null;
5959
}
@@ -93,7 +93,7 @@ export class ActionCodeURL implements externs.ActionCodeURL {
9393
/** {@inheritDoc @firebase/auth-types#ActionCodeURL.languageCode} */
9494
readonly languageCode: string | null;
9595
/** {@inheritDoc @firebase/auth-types#ActionCodeURL.operation} */
96-
readonly operation: externs.Operation;
96+
readonly operation: externs.ActionCodeOperation;
9797
/** {@inheritDoc @firebase/auth-types#ActionCodeURL.tenantId} */
9898
readonly tenantId: string | null;
9999

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,6 @@ describe('core/strategies/credential', () => {
144144
const error = await expect(
145145
signInWithCredential(auth, authCredential)
146146
).to.be.rejectedWith(MultiFactorError);
147-
expect(error.credential).to.eq(authCredential);
148147
expect(error.operationType).to.eq(OperationType.SIGN_IN);
149148
expect(error.serverResponse).to.eql(serverResponse);
150149
expect(error.user).to.be.undefined;

‎packages-exp/auth-exp/src/core/strategies/email.test.ts

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import * as chaiAsPromised from 'chai-as-promised';
2020
import { restore, SinonStub, stub } from 'sinon';
2121
import * as sinonChai from 'sinon-chai';
2222

23-
import { Operation, ProviderId } from '@firebase/auth-types-exp';
23+
import { ActionCodeOperation, ProviderId } from '@firebase/auth-types-exp';
2424
import { FirebaseError, isNode } from '@firebase/util';
2525

2626
import { mockEndpoint } from '../../../test/helpers/api/helper';
@@ -121,38 +121,38 @@ describe('core/strategies/sendEmailVerification', () => {
121121

122122
it('should send the email verification', async () => {
123123
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
124-
requestType: Operation.VERIFY_EMAIL,
124+
requestType: ActionCodeOperation.VERIFY_EMAIL,
125125
email
126126
});
127127

128128
await sendEmailVerification(user);
129129

130130
expect(reloadStub).to.not.have.been.called;
131131
expect(mock.calls[0].request).to.eql({
132-
requestType: Operation.VERIFY_EMAIL,
132+
requestType: ActionCodeOperation.VERIFY_EMAIL,
133133
idToken
134134
});
135135
});
136136

137137
it('should reload the user if the API returns a different email', async () => {
138138
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
139-
requestType: Operation.VERIFY_EMAIL,
139+
requestType: ActionCodeOperation.VERIFY_EMAIL,
140140
email: '[email protected]'
141141
});
142142

143143
await sendEmailVerification(user);
144144

145145
expect(reloadStub).to.have.been.calledOnce;
146146
expect(mock.calls[0].request).to.eql({
147-
requestType: Operation.VERIFY_EMAIL,
147+
requestType: ActionCodeOperation.VERIFY_EMAIL,
148148
idToken
149149
});
150150
});
151151

152152
context('on iOS', () => {
153153
it('should pass action code parameters', async () => {
154154
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
155-
requestType: Operation.VERIFY_EMAIL,
155+
requestType: ActionCodeOperation.VERIFY_EMAIL,
156156
email
157157
});
158158
await sendEmailVerification(user, {
@@ -165,7 +165,7 @@ describe('core/strategies/sendEmailVerification', () => {
165165
});
166166

167167
expect(mock.calls[0].request).to.eql({
168-
requestType: Operation.VERIFY_EMAIL,
168+
requestType: ActionCodeOperation.VERIFY_EMAIL,
169169
idToken,
170170
continueUrl: 'my-url',
171171
dynamicLinkDomain: 'fdl-domain',
@@ -178,7 +178,7 @@ describe('core/strategies/sendEmailVerification', () => {
178178
context('on Android', () => {
179179
it('should pass action code parameters', async () => {
180180
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
181-
requestType: Operation.VERIFY_EMAIL,
181+
requestType: ActionCodeOperation.VERIFY_EMAIL,
182182
email
183183
});
184184
await sendEmailVerification(user, {
@@ -192,7 +192,7 @@ describe('core/strategies/sendEmailVerification', () => {
192192
dynamicLinkDomain: 'fdl-domain'
193193
});
194194
expect(mock.calls[0].request).to.eql({
195-
requestType: Operation.VERIFY_EMAIL,
195+
requestType: ActionCodeOperation.VERIFY_EMAIL,
196196
idToken,
197197
continueUrl: 'my-url',
198198
dynamicLinkDomain: 'fdl-domain',
@@ -227,31 +227,31 @@ describe('core/strategies/verifyBeforeUpdateEmail', () => {
227227

228228
it('should send the email verification', async () => {
229229
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
230-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
230+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
231231
email
232232
});
233233

234234
await verifyBeforeUpdateEmail(user, newEmail);
235235

236236
expect(reloadStub).to.not.have.been.called;
237237
expect(mock.calls[0].request).to.eql({
238-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
238+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
239239
idToken,
240240
newEmail
241241
});
242242
});
243243

244244
it('should reload the user if the API returns a different email', async () => {
245245
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
246-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
246+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
247247
email: '[email protected]'
248248
});
249249

250250
await verifyBeforeUpdateEmail(user, newEmail);
251251

252252
expect(reloadStub).to.have.been.calledOnce;
253253
expect(mock.calls[0].request).to.eql({
254-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
254+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
255255
idToken,
256256
newEmail
257257
});
@@ -260,7 +260,7 @@ describe('core/strategies/verifyBeforeUpdateEmail', () => {
260260
context('on iOS', () => {
261261
it('should pass action code parameters', async () => {
262262
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
263-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
263+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
264264
email
265265
});
266266
await verifyBeforeUpdateEmail(user, newEmail, {
@@ -273,7 +273,7 @@ describe('core/strategies/verifyBeforeUpdateEmail', () => {
273273
});
274274

275275
expect(mock.calls[0].request).to.eql({
276-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
276+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
277277
idToken,
278278
newEmail,
279279
continueUrl: 'my-url',
@@ -287,7 +287,7 @@ describe('core/strategies/verifyBeforeUpdateEmail', () => {
287287
context('on Android', () => {
288288
it('should pass action code parameters', async () => {
289289
const mock = mockEndpoint(Endpoint.SEND_OOB_CODE, {
290-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
290+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
291291
email
292292
});
293293
await verifyBeforeUpdateEmail(user, newEmail, {
@@ -301,7 +301,7 @@ describe('core/strategies/verifyBeforeUpdateEmail', () => {
301301
dynamicLinkDomain: 'fdl-domain'
302302
});
303303
expect(mock.calls[0].request).to.eql({
304-
requestType: Operation.VERIFY_AND_CHANGE_EMAIL,
304+
requestType: ActionCodeOperation.VERIFY_AND_CHANGE_EMAIL,
305305
idToken,
306306
newEmail,
307307
continueUrl: 'my-url',

0 commit comments

Comments
 (0)