Add signInWithCustomToken

Author: sam-gc

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

@@ -20,7 +20,6 @@ import { OperationType, UserCredential } from '@firebase/auth-types-exp';
 
 import { Auth } from '../../model/auth';
 import { AuthCredential } from '../../model/auth_credential';
-import { User } from '../../model/user';
 import { UserCredentialImpl } from '../user/user_credential_impl';
 
 export async function signInWithCredential(
@@ -37,6 +36,6 @@ export async function signInWithCredential(
     OperationType.SIGN_IN,
     response
   );
-  await auth.updateCurrentUser(userCredential.user as User);
+  await auth.updateCurrentUser(userCredential.user);
   return userCredential;
 }

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

@@ -0,0 +1,83 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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.
+ */
+
+import { expect, use } from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+
+import { OperationType } from '@firebase/auth-types-exp';
+
+import { mockEndpoint } from '../../../test/api/helper';
+import { testAuth } from '../../../test/mock_auth';
+import * as mockFetch from '../../../test/mock_fetch';
+import { Endpoint } from '../../api';
+import { APIUserInfo } from '../../api/account_management/account';
+import { Auth } from '../../model/auth';
+import { IdTokenResponse } from '../../model/id_token';
+import { signInWithCustomToken } from './custom_token';
+
+use(chaiAsPromised);
+
+describe('core/strategies/signInWithCustomToken', () => {
+  const serverUser: APIUserInfo = {
+    localId: 'local-id',
+    displayName: 'display-name',
+    photoUrl: 'photo-url',
+    email: 'email',
+    emailVerified: true,
+    phoneNumber: 'phone-number',
+    tenantId: 'tenant-id',
+    createdAt: 123,
+    lastLoginAt: 456
+  };
+
+  const idTokenResponse: IdTokenResponse = {
+    idToken: 'my-id-token',
+    refreshToken: 'my-refresh-token',
+    expiresIn: '1234',
+    localId: serverUser.localId!,
+    kind: 'my-kind'
+  };
+
+  let auth: Auth;
+
+  beforeEach(async () => {
+    auth = await testAuth();
+    mockFetch.setUp();
+    mockEndpoint(Endpoint.SIGN_IN_WITH_CUSTOM_TOKEN, idTokenResponse);
+    mockEndpoint(Endpoint.GET_ACCOUNT_INFO, {
+      users: [serverUser]
+    });
+  });
+  afterEach(mockFetch.tearDown);
+
+  it('should return a valid user credential', async () => {
+    const { credential, user, operationType } = await signInWithCustomToken(
+      auth,
+      'look-at-me-im-a-jwt'
+    );
+    expect(credential).to.be.null;
+    expect(user.uid).to.eq('local-id');
+    expect(user.tenantId).to.eq('tenant-id');
+    expect(user.displayName).to.eq('display-name');
+    expect(operationType).to.eq(OperationType.SIGN_IN);
+  });
+
+  it('should update the current user', async () => {
+    const { user } = await signInWithCustomToken(auth, 'oh.no');
+    expect(auth.currentUser).to.eq(user);
+  });
+});

packages-exp/auth-exp/src/core/strategies/custom_token.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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.
+ */
+
+import * as externs from '@firebase/auth-types-exp';
+
+import { signInWithCustomToken as getIdTokenResponse } from '../../api/authentication/custom_token';
+import { Auth } from '../../model/auth';
+import { IdTokenResponse } from '../../model/id_token';
+import { UserCredentialImpl } from '../user/user_credential_impl';
+
+export async function signInWithCustomToken(
+  authExtern: externs.Auth,
+  customToken: string
+): Promise<externs.UserCredential> {
+  const auth = authExtern as Auth;
+  const response: IdTokenResponse = await getIdTokenResponse(auth, {
+    token: customToken
+  });
+  const cred = await UserCredentialImpl._fromIdTokenResponse(auth, null, externs.OperationType.SIGN_IN, response);
+  await auth.updateCurrentUser(cred.user);
+  return cred;
+}

packages-exp/auth-exp/src/core/user/user_credential_impl.ts

@@ -15,27 +15,28 @@
  * limitations under the License.
  */
 
-import { OperationType, UserCredential, ProviderId } from '@firebase/auth-types-exp';
+import * as externs from '@firebase/auth-types-exp';
+
 import { Auth } from '../../model/auth';
 import { AuthCredential } from '../../model/auth_credential';
 import { IdTokenResponse } from '../../model/id_token';
-import { User } from '../../model/user';
+import { User, UserCredential } from '../../model/user';
 import { UserImpl } from './user_impl';
 
 export class UserCredentialImpl implements UserCredential {
   constructor(
     public readonly user: User,
     public readonly credential: AuthCredential | null,
-    public readonly operationType: OperationType
+    public readonly operationType: externs.OperationType
   ) {}
 
   static async _fromIdTokenResponse(
     auth: Auth,
     credential: AuthCredential | null,
-    operationType: OperationType,
+    operationType: externs.OperationType,
     idTokenResponse: IdTokenResponse
   ): Promise<UserCredential> {
-    const user = await UserImpl._fromIdTokenResponse(auth, idTokenResponse, credential?.providerId === ProviderId.ANONYMOUS);
+    const user = await UserImpl._fromIdTokenResponse(auth, idTokenResponse, credential?.providerId === externs.ProviderId.ANONYMOUS);
     const userCred = new UserCredentialImpl(user, credential, operationType);
     // TODO: handle additional user info
     // updateAdditionalUserInfoFromIdTokenResponse(userCred, idTokenResponse);

packages-exp/auth-exp/src/model/user.d.ts

@@ -48,3 +48,7 @@ export interface User extends externs.User {
   delete(): Promise<void>;
   toPlainObject(): PersistedBlob;
 }
+
+export interface UserCredential extends externs.UserCredential {
+  user: User;
+}