Skip to content

Ensure eventParams is optional in all logEvent overloads #4707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
40 changes: 20 additions & 20 deletions common/api-review/analytics-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'add_payment_i
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_info', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_info', eventParams?: {
coupon?: EventParams['coupon'];
currency?: EventParams['currency'];
items?: EventParams['items'];
Expand All @@ -190,15 +190,15 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'add_shipping_
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams?: {
currency?: EventParams['currency'];
value?: EventParams['value'];
items?: EventParams['items'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkout', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkout', eventParams?: {
currency?: EventParams['currency'];
coupon?: EventParams['coupon'];
value?: EventParams['value'];
Expand All @@ -207,7 +207,7 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'begin_checkou
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'checkout_progress', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'checkout_progress', eventParams?: {
currency?: EventParams['currency'];
coupon?: EventParams['coupon'];
value?: EventParams['value'];
Expand All @@ -218,36 +218,36 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'checkout_prog
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'exception', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'exception', eventParams?: {
description?: EventParams['description'];
fatal?: EventParams['fatal'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'generate_lead', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'generate_lead', eventParams?: {
value?: EventParams['value'];
currency?: EventParams['currency'];
transaction_id?: EventParams['transaction_id'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'login', eventParams?: {
method?: EventParams['method'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'page_view', eventParams?: {
page_title?: string;
page_location?: string;
page_path?: string;
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | 'refund', eventParams?: {
value?: EventParams['value'];
currency?: EventParams['currency'];
transaction_id: EventParams['transaction_id'];
Expand All @@ -260,7 +260,7 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'purchase' | '
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'screen_view', eventParams?: {
app_name: string;
screen_name: EventParams['screen_name'];
app_id?: string;
Expand All @@ -270,13 +270,13 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'screen_view',
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'search' | 'view_search_results', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'search' | 'view_search_results', eventParams?: {
search_term?: EventParams['search_term'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'select_content', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'select_content', eventParams?: {
items?: EventParams['items'];
promotions?: EventParams['promotions'];
content_type?: EventParams['content_type'];
Expand All @@ -285,44 +285,44 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'select_conten
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'select_item', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'select_item', eventParams?: {
items?: EventParams['items'];
item_list_name?: EventParams['item_list_name'];
item_list_id?: EventParams['item_list_id'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'select_promotion' | 'view_promotion', eventParams?: {
items?: EventParams['items'];
promotion_id?: EventParams['promotion_id'];
promotion_name?: EventParams['promotion_name'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'set_checkout_option', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'set_checkout_option', eventParams?: {
checkout_step?: EventParams['checkout_step'];
checkout_option?: EventParams['checkout_option'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'share', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'share', eventParams?: {
method?: EventParams['method'];
content_type?: EventParams['content_type'];
content_id?: EventParams['content_id'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'sign_up', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'sign_up', eventParams?: {
method?: EventParams['method'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'timing_complete', eventParams?: {
name: string;
value: number;
event_category?: string;
Expand All @@ -331,15 +331,15 @@ export function logEvent(analyticsInstance: Analytics, eventName: 'timing_comple
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'view_cart' | 'view_item', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'view_cart' | 'view_item', eventParams?: {
currency?: EventParams['currency'];
items?: EventParams['items'];
value?: EventParams['value'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;

// @public
export function logEvent(analyticsInstance: Analytics, eventName: 'view_item_list', eventParams: {
export function logEvent(analyticsInstance: Analytics, eventName: 'view_item_list', eventParams?: {
items?: EventParams['items'];
item_list_name?: EventParams['item_list_name'];
item_list_id?: EventParams['item_list_id'];
Expand Down
7 changes: 4 additions & 3 deletions common/api-review/auth-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -671,10 +671,11 @@ export function updatePassword(user: User, newPassword: string): Promise<void>;
// @public
export function updatePhoneNumber(user: User, credential: PhoneAuthCredential): Promise<void>;

// Warning: (ae-forgotten-export) The symbol "Profile" needs to be exported by the entry point index.d.ts
//
// @public
export function updateProfile(user: User, { displayName, photoURL: photoUrl }: Profile): Promise<void>;
export function updateProfile(user: User, { displayName, photoURL: photoUrl }: {
displayName?: string | null;
photoURL?: string | null;
}): Promise<void>;

// @public
export function useAuthEmulator(auth: Auth, url: string, options?: {
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/messaging-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```ts

import { FirebaseApp } from '@firebase/app';
import { FirebaseApp } from '@firebase/app-exp';
import { NextFn } from '@firebase/util';
import { Observer } from '@firebase/util';
import { Unsubscribe } from '@firebase/util';
Expand Down
13 changes: 13 additions & 0 deletions docs-exp/analytics-types.analytics.app.md
Original file line number Diff line number Diff line change
@@ -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;
```
18 changes: 18 additions & 0 deletions docs-exp/analytics-types.analytics.md
Original file line number Diff line number Diff line change
@@ -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. |

13 changes: 13 additions & 0 deletions docs-exp/analytics-types.analyticscalloptions.global.md
Original file line number Diff line number Diff line change
@@ -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;
```
20 changes: 20 additions & 0 deletions docs-exp/analytics-types.analyticscalloptions.md
Original file line number Diff line number Diff line change
@@ -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. |

11 changes: 11 additions & 0 deletions docs-exp/analytics-types.controlparams.event_callback.md
Original file line number Diff line number Diff line change
@@ -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;
```
11 changes: 11 additions & 0 deletions docs-exp/analytics-types.controlparams.event_timeout.md
Original file line number Diff line number Diff line change
@@ -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;
```
11 changes: 11 additions & 0 deletions docs-exp/analytics-types.controlparams.groups.md
Original file line number Diff line number Diff line change
@@ -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[];
```
23 changes: 23 additions & 0 deletions docs-exp/analytics-types.controlparams.md
Original file line number Diff line number Diff line change
@@ -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\[\] | |

11 changes: 11 additions & 0 deletions docs-exp/analytics-types.controlparams.send_to.md
Original file line number Diff line number Diff line change
@@ -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[];
```
11 changes: 11 additions & 0 deletions docs-exp/analytics-types.currency.md
Original file line number Diff line number Diff line change
@@ -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;
```
13 changes: 13 additions & 0 deletions docs-exp/analytics-types.customparams.md
Original file line number Diff line number Diff line change
@@ -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
```
11 changes: 11 additions & 0 deletions docs-exp/analytics-types.datalayer.md
Original file line number Diff line number Diff line change
@@ -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>;
```
11 changes: 11 additions & 0 deletions docs-exp/analytics-types.dynamicconfig.apikey.md
Original file line number Diff line number Diff line change
@@ -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;
```
11 changes: 11 additions & 0 deletions docs-exp/analytics-types.dynamicconfig.appid.md
Original file line number Diff line number Diff line change
@@ -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;
```
Loading