add docs-devsite from master

Author: hsubox76

common/api-review/auth.api.md

@@ -103,14 +103,14 @@ export class AuthCredential {
     protected constructor(
     providerId: string,
     signInMethod: string);
-    // Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
-    // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
+    // Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
     //
     // @internal (undocumented)
     _getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
     // @internal (undocumented)
     _getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
-    // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
+    // Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
     //
     // @internal (undocumented)
     _linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
@@ -283,9 +283,6 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
     disableWarnings: boolean;
 }): void;
 
-// @public
-export const cordovaPopupRedirectResolver: PopupRedirectResolver;
-
 // @public
 export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
 
@@ -349,7 +346,7 @@ export interface EmulatorConfig {
 
 export { ErrorFn }
 
-// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
+// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
 //
 // @public
 export class FacebookAuthProvider extends BaseOAuthProvider {
@@ -384,9 +381,6 @@ export function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<Id
 // @public
 export function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
 
-// @public
-export function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;
-
 // @public
 export function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
 
@@ -496,7 +490,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
 export class OAuthCredential extends AuthCredential {
     accessToken?: string;
     static fromJSON(json: string | object): OAuthCredential | null;
-    // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
+    // Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
     //
     // @internal (undocumented)
     static _fromParams(params: OAuthCredentialParams): OAuthCredential;
@@ -574,7 +568,7 @@ export class PhoneAuthCredential extends AuthCredential {
     _getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
     // @internal (undocumented)
     _linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
-    // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
+    // Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
     //
     // @internal (undocumented)
     _makeVerificationRequest(): SignInWithPhoneNumberRequest;
@@ -653,9 +647,6 @@ export interface ReactNativeAsyncStorage {
     setItem(key: string, value: string): Promise<void>;
 }
 
-// @public
-export const reactNativeLocalPersistence: Persistence;
-
 // @public
 export function reauthenticateWithCredential(user: User, credential: AuthCredential): Promise<UserCredential>;
 
@@ -674,13 +665,13 @@ export interface RecaptchaParameters {
     [key: string]: any;
 }
 
-// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
+// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
 //
 // @public
 export class RecaptchaVerifier implements ApplicationVerifierInternal {
     constructor(containerOrId: HTMLElement | string, parameters: RecaptchaParameters, authExtern: Auth);
     clear(): void;
-    // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
+    // Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
     //
     // @internal (undocumented)
     readonly _recaptchaLoader: ReCaptchaLoader;
@@ -694,7 +685,7 @@ export class RecaptchaVerifier implements ApplicationVerifierInternal {
 // @public
 export function reload(user: User): Promise<void>;
 
-// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
+// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
 //
 // @public
 export class SAMLAuthProvider extends FederatedAuthProvider {

docs-devsite/analytics.analytics.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# Analytics interface
+An instance of Firebase Analytics.
+
+<b>Signature:</b>
+
+```typescript
+export interface Analytics 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [app](./analytics.analytics.md#analyticsapp) | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Analytics](./analytics.analytics.md#analytics_interface) instance is associated with. |
+
+## Analytics.app
+
+The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) this [Analytics](./analytics.analytics.md#analytics_interface) instance is associated with.
+
+<b>Signature:</b>
+
+```typescript
+app: FirebaseApp;
+```

docs-devsite/analytics.analyticscalloptions.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# AnalyticsCallOptions interface
+Additional options that can be passed to Analytics method calls such as `logEvent`<!-- -->, etc.
+
+<b>Signature:</b>
+
+```typescript
+export interface AnalyticsCallOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [global](./analytics.analyticscalloptions.md#analyticscalloptionsglobal) | boolean | If true, this config or event call applies globally to all Google Analytics properties on the page. |
+
+## AnalyticsCallOptions.global
+
+If true, this config or event call applies globally to all Google Analytics properties on the page.
+
+<b>Signature:</b>
+
+```typescript
+global: boolean;
+```

docs-devsite/analytics.analyticssettings.md

@@ -0,0 +1,35 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# AnalyticsSettings interface
+[Analytics](./analytics.analytics.md#analytics_interface) instance initialization options.
+
+<b>Signature:</b>
+
+```typescript
+export interface AnalyticsSettings 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [config](./analytics.analyticssettings.md#analyticssettingsconfig) | [GtagConfigParams](./analytics.gtagconfigparams.md#gtagconfigparams_interface) \| [EventParams](./analytics.eventparams.md#eventparams_interface) | Params to be passed in the initial <code>gtag</code> config call during Firebase Analytics initialization. |
+
+## AnalyticsSettings.config
+
+Params to be passed in the initial `gtag` config call during Firebase Analytics initialization.
+
+<b>Signature:</b>
+
+```typescript
+config?: GtagConfigParams | EventParams;
+```

docs-devsite/analytics.consentsettings.md

@@ -0,0 +1,79 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# ConsentSettings interface
+Consent status settings for each consent type. For more information, see [the GA4 reference documentation for consent state and consent types](https://developers.google.com/tag-platform/tag-manager/templates/consent-apis)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface ConsentSettings 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [ad\_storage](./analytics.consentsettings.md#consentsettingsad_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to advertising |
+|  [analytics\_storage](./analytics.consentsettings.md#consentsettingsanalytics_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage, such as cookies, related to analytics (for example, visit duration) |
+|  [functionality\_storage](./analytics.consentsettings.md#consentsettingsfunctionality_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage that supports the functionality of the website or app such as language settings |
+|  [personalization\_storage](./analytics.consentsettings.md#consentsettingspersonalization_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage related to personalization such as video recommendations |
+|  [security\_storage](./analytics.consentsettings.md#consentsettingssecurity_storage) | [ConsentStatusString](./analytics.md#consentstatusstring) | Enables storage related to security such as authentication functionality, fraud prevention, and other user protection. |
+
+## ConsentSettings.ad\_storage
+
+Enables storage, such as cookies, related to advertising
+
+<b>Signature:</b>
+
+```typescript
+ad_storage?: ConsentStatusString;
+```
+
+## ConsentSettings.analytics\_storage
+
+Enables storage, such as cookies, related to analytics (for example, visit duration)
+
+<b>Signature:</b>
+
+```typescript
+analytics_storage?: ConsentStatusString;
+```
+
+## ConsentSettings.functionality\_storage
+
+Enables storage that supports the functionality of the website or app such as language settings
+
+<b>Signature:</b>
+
+```typescript
+functionality_storage?: ConsentStatusString;
+```
+
+## ConsentSettings.personalization\_storage
+
+Enables storage related to personalization such as video recommendations
+
+<b>Signature:</b>
+
+```typescript
+personalization_storage?: ConsentStatusString;
+```
+
+## ConsentSettings.security\_storage
+
+Enables storage related to security such as authentication functionality, fraud prevention, and other user protection.
+
+<b>Signature:</b>
+
+```typescript
+security_storage?: ConsentStatusString;
+```

docs-devsite/analytics.controlparams.md

@@ -0,0 +1,60 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# ControlParams interface
+Standard `gtag.js` control parameters. For more information, see [the GA4 reference documentation](https://developers.google.com/gtagjs/reference/ga4-events)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface ControlParams 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [event\_callback](./analytics.controlparams.md#controlparamsevent_callback) | () =&gt; void |  |
+|  [event\_timeout](./analytics.controlparams.md#controlparamsevent_timeout) | number |  |
+|  [groups](./analytics.controlparams.md#controlparamsgroups) | string \| string\[\] |  |
+|  [send\_to](./analytics.controlparams.md#controlparamssend_to) | string \| string\[\] |  |
+
+## ControlParams.event\_callback
+
+<b>Signature:</b>
+
+```typescript
+event_callback?: () => void;
+```
+
+## ControlParams.event\_timeout
+
+<b>Signature:</b>
+
+```typescript
+event_timeout?: number;
+```
+
+## ControlParams.groups
+
+<b>Signature:</b>
+
+```typescript
+groups?: string | string[];
+```
+
+## ControlParams.send\_to
+
+<b>Signature:</b>
+
+```typescript
+send_to?: string | string[];
+```

docs-devsite/analytics.customparams.md

@@ -0,0 +1,19 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# CustomParams interface
+Any custom params the user may pass to `gtag`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface CustomParams 
+```