Merge master into release

Author: google-oss-bot

.changeset/soft-zoos-listen.md

@@ -0,0 +1,5 @@
+---
+'@firebase/auth': patch
+---
+
+Fix typings for `TotpMultiFactorGenerator`. This fixes a reversion in 9.19.0.

.github/CODEOWNERS

@@ -96,7 +96,7 @@ packages/app-check-interop-types @hsubox76 @firebase/jssdk-global-approvers
 # Documentation Changes
 packages/firebase/index.d.ts @egilmorez @firebase/jssdk-global-approvers
 scripts/docgen/content-sources/ @egilmorez @firebase/jssdk-global-approvers
-docs-devsite/ @egilmorez @markarndt
+docs-devsite/ @egilmorez @markarndt @kevinthecheung
 
 # Changeset
 .changeset @firebase/jssdk-changeset-approvers @firebase/firestore-js-team @firebase/jssdk-global-approvers

common/api-review/auth.api.md

@@ -754,8 +754,7 @@ export interface TotpMultiFactorAssertion extends MultiFactorAssertion {
 export class TotpMultiFactorGenerator {
     static assertionForEnrollment(secret: TotpSecret, oneTimePassword: string): TotpMultiFactorAssertion;
     static assertionForSignIn(enrollmentId: string, oneTimePassword: string): TotpMultiFactorAssertion;
-    // Warning: (ae-forgotten-export) The symbol "FactorId" needs to be exported by the entry point index.d.ts
-    static FACTOR_ID: FactorId_2;
+    static FACTOR_ID: "totp";
     static generateSecret(session: MultiFactorSession): Promise<TotpSecret>;
 }
 

docs-devsite/auth.md

@@ -536,7 +536,7 @@ export declare function onAuthStateChanged(auth: Auth, nextOrObserver: NextOrObs
 
 Adds an observer for changes to the signed-in user's ID token.
 
-This includes sign-in, sign-out, and token refresh events.
+This includes sign-in, sign-out, and token refresh events. This will not be triggered automatically upon ID token expiration. Use [User.getIdToken()](./auth.user.md#usergetidtoken) to refresh the ID token.
 
 <b>Signature:</b>
 

docs-devsite/auth.totpmultifactorgenerator.md

@@ -22,7 +22,7 @@ export declare class TotpMultiFactorGenerator
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [FACTOR\_ID](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorfactor_id) | <code>static</code> | FactorId | The identifier of the TOTP second factor: <code>totp</code>. |
+|  [FACTOR\_ID](./auth.totpmultifactorgenerator.md#totpmultifactorgeneratorfactor_id) | <code>static</code> | 'totp' | The identifier of the TOTP second factor: <code>totp</code>. |
 
 ## Methods
 
@@ -39,7 +39,7 @@ The identifier of the TOTP second factor: `totp`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-static FACTOR_ID: FactorId;
+static FACTOR_ID: 'totp';
 ```
 
 ## TotpMultiFactorGenerator.assertionForEnrollment()

docs-devsite/firestore_.firestoresettings.md

@@ -27,7 +27,7 @@ export declare interface FirestoreSettings
 |  [experimentalForceLongPolling](./firestore_.firestoresettings.md#firestoresettingsexperimentalforcelongpolling) | boolean | Forces the SDK’s underlying network transport (WebChannel) to use long-polling. Each response from the backend will be closed immediately after the backend sends data (by default responses are kept open in case the backend has more data to send). This avoids incompatibility issues with certain proxies, antivirus software, etc. that incorrectly buffer traffic indefinitely. Use of this option will cause some performance degradation though.<!-- -->This setting cannot be used with <code>experimentalAutoDetectLongPolling</code> and may be removed in a future release. If you find yourself using it to work around a specific network reliability issue, please tell us about it in https://github.com/firebase/firebase-js-sdk/issues/1674. |
 |  [host](./firestore_.firestoresettings.md#firestoresettingshost) | string | The hostname to connect to. |
 |  [ignoreUndefinedProperties](./firestore_.firestoresettings.md#firestoresettingsignoreundefinedproperties) | boolean | Whether to skip nested properties that are set to <code>undefined</code> during object serialization. If set to <code>true</code>, these properties are skipped and not written to Firestore. If set to <code>false</code> or omitted, the SDK throws an exception when it encounters properties of type <code>undefined</code>. |
-|  [localCache](./firestore_.firestoresettings.md#firestoresettingslocalcache) | [FirestoreLocalCache](./firestore_.md#firestorelocalcache) | Specifies the cache used by the SDK. Availabe options are <code>MemoryLocalCache</code> and <code>IndexedDbLocalCache</code>, each with different configuration options.<!-- -->When unspecified, <code>MemoryLocalCache</code> will be used by default.<!-- -->NOTE: setting this field and <code>cacheSizeBytes</code> at the same time will throw exception during SDK initialization. Instead, using the configuration in the <code>FirestoreLocalCache</code> object to specify the cache size. |
+|  [localCache](./firestore_.firestoresettings.md#firestoresettingslocalcache) | [FirestoreLocalCache](./firestore_.md#firestorelocalcache) | Specifies the cache used by the SDK. Available options are <code>MemoryLocalCache</code> and <code>IndexedDbLocalCache</code>, each with different configuration options.<!-- -->When unspecified, <code>MemoryLocalCache</code> will be used by default.<!-- -->NOTE: setting this field and <code>cacheSizeBytes</code> at the same time will throw exception during SDK initialization. Instead, using the configuration in the <code>FirestoreLocalCache</code> object to specify the cache size. |
 |  [ssl](./firestore_.firestoresettings.md#firestoresettingsssl) | boolean | Whether to use SSL when connecting. |
 
 ## FirestoreSettings.cacheSizeBytes
@@ -90,7 +90,7 @@ ignoreUndefinedProperties?: boolean;
 
 ## FirestoreSettings.localCache
 
-Specifies the cache used by the SDK. Availabe options are `MemoryLocalCache` and `IndexedDbLocalCache`<!-- -->, each with different configuration options.
+Specifies the cache used by the SDK. Available options are `MemoryLocalCache` and `IndexedDbLocalCache`<!-- -->, each with different configuration options.
 
 When unspecified, `MemoryLocalCache` will be used by default.
 

docs-devsite/firestore_.md

@@ -157,9 +157,9 @@ https://github.com/firebase/firebase-js-sdk
 |  [PersistenceSettings](./firestore_.persistencesettings.md#persistencesettings_interface) | Settings that can be passed to <code>enableIndexedDbPersistence()</code> to configure Firestore persistence. |
 |  [PersistentCacheSettings](./firestore_.persistentcachesettings.md#persistentcachesettings_interface) | An settings object to configure an <code>PersistentLocalCache</code> instance. |
 |  [PersistentLocalCache](./firestore_.persistentlocalcache.md#persistentlocalcache_interface) | Provides a persistent cache backed by IndexedDb to the SDK.<!-- -->To use, create an instance using the factory function , then set the instance to <code>FirestoreSettings.cache</code> and call <code>initializeFirestore</code> using the settings object. |
-|  [PersistentMultipleTabManager](./firestore_.persistentmultipletabmanager.md#persistentmultipletabmanager_interface) | A tab manager supportting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK. |
+|  [PersistentMultipleTabManager](./firestore_.persistentmultipletabmanager.md#persistentmultipletabmanager_interface) | A tab manager supporting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK. |
 |  [PersistentSingleTabManager](./firestore_.persistentsingletabmanager.md#persistentsingletabmanager_interface) | A tab manager supportting only one tab, no synchronization will be performed across tabs. |
-|  [PersistentSingleTabManagerSettings](./firestore_.persistentsingletabmanagersettings.md#persistentsingletabmanagersettings_interface) | Type to configure an <code>PersistentSingleTabManager</code> instace. |
+|  [PersistentSingleTabManagerSettings](./firestore_.persistentsingletabmanagersettings.md#persistentsingletabmanagersettings_interface) | Type to configure an <code>PersistentSingleTabManager</code> instance. |
 |  [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md#snapshotlistenoptions_interface) | An options object that can be passed to [onSnapshot()](./firestore_.md#onsnapshot) and [QuerySnapshot.docChanges()](./firestore_.querysnapshot.md#querysnapshotdocchanges) to control which types of changes to include in the result set. |
 |  [SnapshotOptions](./firestore_.snapshotoptions.md#snapshotoptions_interface) | Options that configure how data is retrieved from a <code>DocumentSnapshot</code> (for example the desired behavior for server timestamps that have not yet been set to their final value). |
 |  [TransactionOptions](./firestore_.transactionoptions.md#transactionoptions_interface) | Options to customize transaction behavior. |
@@ -185,7 +185,7 @@ https://github.com/firebase/firebase-js-sdk
 |  [NestedUpdateFields](./firestore_.md#nestedupdatefields) | For each field (e.g. 'bar'), find all nested keys (e.g. {<!-- -->'bar.baz': T1, 'bar.qux': T2<!-- -->}<!-- -->). Intersect them together to make a single map containing all possible keys that are all marked as optional |
 |  [OrderByDirection](./firestore_.md#orderbydirection) | The direction of a [orderBy()](./firestore_.md#orderby) clause is specified as 'desc' or 'asc' (descending or ascending). |
 |  [PartialWithFieldValue](./firestore_.md#partialwithfieldvalue) | Similar to Typescript's <code>Partial&lt;T&gt;</code>, but allows nested fields to be omitted and FieldValues to be passed in as property values. |
-|  [PersistentTabManager](./firestore_.md#persistenttabmanager) | A union of all avaialbe tab managers. |
+|  [PersistentTabManager](./firestore_.md#persistenttabmanager) | A union of all available tab managers. |
 |  [Primitive](./firestore_.md#primitive) | Primitive types. |
 |  [QueryConstraintType](./firestore_.md#queryconstrainttype) | Describes the different query constraints available in this SDK. |
 |  [QueryFilterConstraint](./firestore_.md#queryfilterconstraint) | <code>QueryFilterConstraint</code> is a helper union type that represents [QueryFieldFilterConstraint](./firestore_.queryfieldfilterconstraint.md#queryfieldfilterconstraint_class) and [QueryCompositeFilterConstraint](./firestore_.querycompositefilterconstraint.md#querycompositefilterconstraint_class)<!-- -->. |
@@ -2208,7 +2208,7 @@ export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive
 
 ## PersistentTabManager
 
-A union of all avaialbe tab managers.
+A union of all available tab managers.
 
 <b>Signature:</b>
 

docs-devsite/firestore_.persistentmultipletabmanager.md

@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # PersistentMultipleTabManager interface
-A tab manager supportting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK.
+A tab manager supporting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK.
 
 <b>Signature:</b>
 

docs-devsite/firestore_.persistentsingletabmanagersettings.md

@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
 {% endcomment %}
 
 # PersistentSingleTabManagerSettings interface
-Type to configure an `PersistentSingleTabManager` instace.
+Type to configure an `PersistentSingleTabManager` instance.
 
 <b>Signature:</b>
 

packages/auth/README.md

@@ -40,6 +40,11 @@ commands also run various tests:
   * `yarn test:webdriver` — Executes only the Selenium WebDriver
     integration tests
 
+Note - The webdriver tests require the Chrome webdriver to match the version of Chrome running locally.
+In the CI environment, this is ensured using the environment variable [here.](https://github.com/firebase/firebase-js-sdk/blob/6e80a678fe0c31046860554cec0459a2be34d22b/.github/workflows/test-changed-auth.yml#L7)
+When running locally, change the chromedriver version in [package.json](https://github.com/firebase/firebase-js-sdk/blob/6e80a678fe0c31046860554cec0459a2be34d22b/packages/auth/package.json#L124) to match your local Chrome version and run `yarn install`.
+
+
 For example, to run all integration and WebDriver tests against the emulator,
 you would simply execute the following command:
 

packages/auth/api-extractor.json

@@ -6,4 +6,4 @@
         "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
         "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
     }
-}
+}

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

@@ -76,7 +76,7 @@ describe('api/authentication/signInWithPassword', () => {
     );
   });
 
-  it('should handle errors', async () => {
+  it('should handle errors for invalid password', async () => {
     const mock = mockEndpoint(
       Endpoint.SIGN_IN_WITH_PASSWORD,
       {
@@ -99,6 +99,31 @@ describe('api/authentication/signInWithPassword', () => {
     );
     expect(mock.calls[0].request).to.eql(request);
   });
+
+  it('should handle errors for missing password', async () => {
+    request.password = '';
+    const mock = mockEndpoint(
+      Endpoint.SIGN_IN_WITH_PASSWORD,
+      {
+        error: {
+          code: 400,
+          message: ServerError.MISSING_PASSWORD,
+          errors: [
+            {
+              message: ServerError.MISSING_PASSWORD
+            }
+          ]
+        }
+      },
+      400
+    );
+
+    await expect(signInWithPassword(auth, request)).to.be.rejectedWith(
+      FirebaseError,
+      'Firebase: A non-empty password must be provided (auth/missing-password).'
+    );
+    expect(mock.calls[0].request).to.eql(request);
+  });
 });
 
 describe('api/authentication/sendEmailVerification', () => {

packages/auth/src/api/errors.ts

@@ -134,7 +134,7 @@ export const SERVER_ERROR_MAP: Partial<ServerErrorMap<ServerError>> = {
   // Sign in with email and password errors (some apply to sign up too).
   [ServerError.INVALID_PASSWORD]: AuthErrorCode.INVALID_PASSWORD,
   // This can only happen if the SDK sends a bad request.
-  [ServerError.MISSING_PASSWORD]: AuthErrorCode.INTERNAL_ERROR,
+  [ServerError.MISSING_PASSWORD]: AuthErrorCode.MISSING_PASSWORD,
 
   // Sign up with email and password errors.
   [ServerError.EMAIL_EXISTS]: AuthErrorCode.EMAIL_EXISTS,

packages/auth/src/core/errors.ts

@@ -89,6 +89,7 @@ export const enum AuthErrorCode {
   MISSING_MFA_INFO = 'missing-multi-factor-info',
   MISSING_MFA_SESSION = 'missing-multi-factor-session',
   MISSING_PHONE_NUMBER = 'missing-phone-number',
+  MISSING_PASSWORD = 'missing-password',
   MISSING_SESSION_INFO = 'missing-verification-id',
   MODULE_DESTROYED = 'app-deleted',
   NEED_CONFIRMATION = 'account-exists-with-different-credential',
@@ -267,6 +268,7 @@ function _debugErrorMap(): ErrorMap<AuthErrorCode> {
       'The request does not contain a valid nonce. This can occur if the ' +
       'SHA-256 hash of the provided raw nonce does not match the hashed nonce ' +
       'in the ID token payload.',
+    [AuthErrorCode.MISSING_PASSWORD]: 'A non-empty password must be provided',
     [AuthErrorCode.MISSING_MFA_INFO]:
       'No second factor identifier is provided.',
     [AuthErrorCode.MISSING_MFA_SESSION]:

packages/auth/src/core/index.ts

@@ -65,6 +65,7 @@ export function setPersistence(
  *
  * @remarks
  * This includes sign-in, sign-out, and token refresh events.
+ * This will not be triggered automatically upon ID token expiration. Use {@link User.getIdToken} to refresh the ID token.
  *
  * @param auth - The {@link Auth} instance.
  * @param nextOrObserver - callback triggered on change.

packages/auth/src/mfa/assertions/totp.ts

@@ -107,7 +107,7 @@ export class TotpMultiFactorGenerator {
   /**
    * The identifier of the TOTP second factor: `totp`.
    */
-  static FACTOR_ID = FactorId.TOTP;
+  static FACTOR_ID: 'totp' = FactorId.TOTP;
 }
 
 export class TotpMultiFactorAssertionImpl

packages/firestore/src/api/cache_config.ts

@@ -214,7 +214,7 @@ class SingleTabManagerImpl implements PersistentSingleTabManager {
 }
 
 /**
- * A tab manager supportting multiple tabs. SDK will synchronize queries and
+ * A tab manager supporting multiple tabs. SDK will synchronize queries and
  * mutations done across all tabs using the SDK.
  */
 export type PersistentMultipleTabManager = {
@@ -265,14 +265,14 @@ class MultiTabManagerImpl implements PersistentMultipleTabManager {
 }
 
 /**
- * A union of all avaialbe tab managers.
+ * A union of all available tab managers.
  */
 export type PersistentTabManager =
   | PersistentSingleTabManager
   | PersistentMultipleTabManager;
 
 /**
- * Type to configure an `PersistentSingleTabManager` instace.
+ * Type to configure an `PersistentSingleTabManager` instance.
  */
 export type PersistentSingleTabManagerSettings = {
   /**

packages/firestore/src/api/settings.ts

@@ -56,7 +56,7 @@ export interface FirestoreSettings extends LiteSettings {
   cacheSizeBytes?: number;
 
   /**
-   * Specifies the cache used by the SDK. Availabe options are `MemoryLocalCache`
+   * Specifies the cache used by the SDK. Available options are `MemoryLocalCache`
    * and `IndexedDbLocalCache`, each with different configuration options.
    *
    * When unspecified, `MemoryLocalCache` will be used by default.