Reference docs for analytics, storage and database exp

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

@@ -17,8 +17,6 @@ import { SettingsOptions } from '@firebase/analytics-types-exp';
 
 export { Analytics }
 
-export { AnalyticsCallOptions }
-
 export { ControlParams }
 
 // @public

common/api-review/analytics-types-exp.api.md

@@ -6,6 +6,11 @@
 
 import { FirebaseApp } from '@firebase/app-types-exp';
 
+// @public (undocumented)
+export interface Analytics {
+  app: FirebaseApp;
+}
+
 // @public
 export interface AnalyticsCallOptions {
   global: boolean;
@@ -122,6 +127,12 @@ export interface EventParams {
   // (undocumented)
   number?: string;
   // (undocumented)
+  page_location?: string;
+  // (undocumented)
+  page_path?: string;
+  // (undocumented)
+  page_title?: string;
+  // (undocumented)
   payment_type?: string;
   // (undocumented)
   promotion_id?: string;
@@ -145,12 +156,6 @@ export interface EventParams {
   value?: number;
 }
 
-// @public (undocumented)
-export interface FirebaseAnalytics {
-  // (undocumented)
-  app: FirebaseApp;
-}
-
 // @public
 export interface Gtag {
   // (undocumented)
@@ -169,9 +174,6 @@ export interface Gtag {
   ): void;
 }
 
-// @public (undocumented)
-export type GtagCommand = 'event' | 'set' | 'config';
-
 // @public (undocumented)
 export interface Item {
   // (undocumented)

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

@@ -78,12 +78,12 @@ export interface Auth {
   languageCode: string | null;
   readonly name: string;
   onAuthStateChanged(
-    nextOrObserver: NextOrObserver<User>,
+    nextOrObserver: NextOrObserver<User | null>,
     error?: ErrorFn,
     completed?: CompleteFn
   ): Unsubscribe;
   onIdTokenChanged(
-    nextOrObserver: NextOrObserver<User>,
+    nextOrObserver: NextOrObserver<User | null>,
     error?: ErrorFn,
     completed?: CompleteFn
   ): Unsubscribe;

common/api-review/database.api.md

@@ -187,7 +187,7 @@ export interface ServerValue {
 // @public (undocumented)
 export interface ThenableReference
   extends Reference,
-  Pick<Promise<Reference>, 'then' | 'catch'> { }
+    Pick<Promise<Reference>, 'then' | 'catch'> {}
 
 
 // (No @packageDocumentation comment for this package)

common/api-review/firestore.api.md

@@ -460,6 +460,9 @@ export function updateDoc(reference: DocumentReference<unknown>, data: UpdateDat
 // @public
 export function updateDoc(reference: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
 
+// @public
+export function useFirestoreEmulator(firestore: FirebaseFirestore, host: string, port: number): void;
+
 // @public
 export function waitForPendingWrites(firestore: FirebaseFirestore): Promise<void>;
 

common/api-review/firestore.lite.api.md

@@ -329,6 +329,9 @@ export function updateDoc(reference: DocumentReference<unknown>, data: UpdateDat
 // @public
 export function updateDoc(reference: DocumentReference<unknown>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;
 
+// @public
+export function useFirestoreEmulator(firestore: FirebaseFirestore, host: string, port: number): void;
+
 // @public
 export function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryConstraint;
 

docs-exp/analytics-types.analytics.app.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [Analytics](./analytics-types.analytics.md) &gt; [app](./analytics-types.analytics.app.md)
+
+## Analytics.app property
+
+The FirebaseApp this Functions instance is associated with.
+
+<b>Signature:</b>
+
+```typescript
+app: FirebaseApp;
+```

docs-exp/analytics-types.analytics.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [Analytics](./analytics-types.analytics.md)
+
+## Analytics interface
+
+<b>Signature:</b>
+
+```typescript
+export interface Analytics 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [app](./analytics-types.analytics.app.md) | [FirebaseApp](./app-types.firebaseapp.md) | The FirebaseApp this Functions instance is associated with. |
+

docs-exp/analytics-types.analyticscalloptions.global.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [AnalyticsCallOptions](./analytics-types.analyticscalloptions.md) &gt; [global](./analytics-types.analyticscalloptions.global.md)
+
+## AnalyticsCallOptions.global property
+
+If true, this config or event call applies globally to all analytics properties on the page.
+
+<b>Signature:</b>
+
+```typescript
+global: boolean;
+```

docs-exp/analytics-types.analyticscalloptions.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [AnalyticsCallOptions](./analytics-types.analyticscalloptions.md)
+
+## AnalyticsCallOptions interface
+
+Additional options that can be passed to Firebase Analytics method calls such as `logEvent`<!-- -->, `setCurrentScreen`<!-- -->, etc.
+
+<b>Signature:</b>
+
+```typescript
+export interface AnalyticsCallOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [global](./analytics-types.analyticscalloptions.global.md) | boolean | If true, this config or event call applies globally to all analytics properties on the page. |
+

docs-exp/analytics-types.controlparams.event_callback.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [event\_callback](./analytics-types.controlparams.event_callback.md)
+
+## ControlParams.event\_callback property
+
+<b>Signature:</b>
+
+```typescript
+event_callback?: () => void;
+```

docs-exp/analytics-types.controlparams.event_timeout.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [event\_timeout](./analytics-types.controlparams.event_timeout.md)
+
+## ControlParams.event\_timeout property
+
+<b>Signature:</b>
+
+```typescript
+event_timeout?: number;
+```

docs-exp/analytics-types.controlparams.groups.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [groups](./analytics-types.controlparams.groups.md)
+
+## ControlParams.groups property
+
+<b>Signature:</b>
+
+```typescript
+groups?: string | string[];
+```

docs-exp/analytics-types.controlparams.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md)
+
+## ControlParams interface
+
+Standard gtag.js control parameters. For more information, see [the gtag.js documentation on parameters](https://developers.google.com/gtagjs/reference/parameter)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface ControlParams 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [event\_callback](./analytics-types.controlparams.event_callback.md) | () =&gt; void |  |
+|  [event\_timeout](./analytics-types.controlparams.event_timeout.md) | number |  |
+|  [groups](./analytics-types.controlparams.groups.md) | string \| string\[\] |  |
+|  [send\_to](./analytics-types.controlparams.send_to.md) | string \| string\[\] |  |
+

docs-exp/analytics-types.controlparams.send_to.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [ControlParams](./analytics-types.controlparams.md) &gt; [send\_to](./analytics-types.controlparams.send_to.md)
+
+## ControlParams.send\_to property
+
+<b>Signature:</b>
+
+```typescript
+send_to?: string | string[];
+```

docs-exp/analytics-types.currency.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [Currency](./analytics-types.currency.md)
+
+## Currency type
+
+<b>Signature:</b>
+
+```typescript
+export type Currency = string | number;
+```

docs-exp/analytics-types.customparams.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [CustomParams](./analytics-types.customparams.md)
+
+## CustomParams interface
+
+Any custom params the user may pass to gtag.js.
+
+<b>Signature:</b>
+
+```typescript
+export interface CustomParams 
+```

docs-exp/analytics-types.datalayer.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DataLayer](./analytics-types.datalayer.md)
+
+## DataLayer type
+
+<b>Signature:</b>
+
+```typescript
+export type DataLayer = Array<IArguments>;
+```

docs-exp/analytics-types.dynamicconfig.apikey.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [apiKey](./analytics-types.dynamicconfig.apikey.md)
+
+## DynamicConfig.apiKey property
+
+<b>Signature:</b>
+
+```typescript
+apiKey: string;
+```

docs-exp/analytics-types.dynamicconfig.appid.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [appId](./analytics-types.dynamicconfig.appid.md)
+
+## DynamicConfig.appId property
+
+<b>Signature:</b>
+
+```typescript
+appId: string;
+```

docs-exp/analytics-types.dynamicconfig.authdomain.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [authDomain](./analytics-types.dynamicconfig.authdomain.md)
+
+## DynamicConfig.authDomain property
+
+<b>Signature:</b>
+
+```typescript
+authDomain: string;
+```

docs-exp/analytics-types.dynamicconfig.databaseurl.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [databaseURL](./analytics-types.dynamicconfig.databaseurl.md)
+
+## DynamicConfig.databaseURL property
+
+<b>Signature:</b>
+
+```typescript
+databaseURL: string;
+```

docs-exp/analytics-types.dynamicconfig.locationid.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [locationId](./analytics-types.dynamicconfig.locationid.md)
+
+## DynamicConfig.locationId property
+
+<b>Signature:</b>
+
+```typescript
+locationId: string;
+```

docs-exp/analytics-types.dynamicconfig.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md)
+
+## DynamicConfig interface
+
+Dynamic configuration fetched from server. See https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps/getConfig
+
+<b>Signature:</b>
+
+```typescript
+interface DynamicConfig 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [apiKey](./analytics-types.dynamicconfig.apikey.md) | string |  |
+|  [appId](./analytics-types.dynamicconfig.appid.md) | string |  |
+|  [authDomain](./analytics-types.dynamicconfig.authdomain.md) | string |  |
+|  [databaseURL](./analytics-types.dynamicconfig.databaseurl.md) | string |  |
+|  [locationId](./analytics-types.dynamicconfig.locationid.md) | string |  |
+|  [measurementId](./analytics-types.dynamicconfig.measurementid.md) | string |  |
+|  [messagingSenderId](./analytics-types.dynamicconfig.messagingsenderid.md) | string |  |
+|  [projectId](./analytics-types.dynamicconfig.projectid.md) | string |  |
+|  [storageBucket](./analytics-types.dynamicconfig.storagebucket.md) | string |  |
+

docs-exp/analytics-types.dynamicconfig.measurementid.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [measurementId](./analytics-types.dynamicconfig.measurementid.md)
+
+## DynamicConfig.measurementId property
+
+<b>Signature:</b>
+
+```typescript
+measurementId: string;
+```

docs-exp/analytics-types.dynamicconfig.messagingsenderid.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@firebase/analytics-types](./analytics-types.md) &gt; [DynamicConfig](./analytics-types.dynamicconfig.md) &gt; [messagingSenderId](./analytics-types.dynamicconfig.messagingsenderid.md)
+
+## DynamicConfig.messagingSenderId property
+
+<b>Signature:</b>
+
+```typescript
+messagingSenderId: string;
+```