Skip to content

Add app property to public typings of all services #5351

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 2 commits into from
Aug 23, 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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions common/api-review/auth.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ export function applyActionCode(auth: Auth, oobCode: string): Promise<void>;

// @public
export interface Auth {
readonly app: FirebaseApp;
readonly config: Config;
readonly currentUser: User | null;
readonly emulatorConfig: EmulatorConfig | null;
Expand Down
83 changes: 42 additions & 41 deletions common/api-review/installations.api.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,42 @@
## API Report File for "@firebase/installations"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseApp } from '@firebase/app';

// @public
export function deleteInstallations(installations: Installations): Promise<void>;

// @internal
export interface _FirebaseInstallationsInternal {
getId(): Promise<string>;
getToken(forceRefresh?: boolean): Promise<string>;
}

// @public
export function getId(installations: Installations): Promise<string>;

// @public
export function getInstallations(app?: FirebaseApp): Installations;

// @public
export function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

// @public
export type IdChangeCallbackFn = (installationId: string) => void;

// @public
export type IdChangeUnsubscribeFn = () => void;

// @public
export interface Installations {
}

// @public
export function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;


```
## API Report File for "@firebase/installations"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseApp } from '@firebase/app';

// @public
export function deleteInstallations(installations: Installations): Promise<void>;

// @internal
export interface _FirebaseInstallationsInternal {
getId(): Promise<string>;
getToken(forceRefresh?: boolean): Promise<string>;
}

// @public
export function getId(installations: Installations): Promise<string>;

// @public
export function getInstallations(app?: FirebaseApp): Installations;

// @public
export function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

// @public
export type IdChangeCallbackFn = (installationId: string) => void;

// @public
export type IdChangeUnsubscribeFn = () => void;

// @public
export interface Installations {
app: FirebaseApp;
}

// @public
export function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;


```
137 changes: 69 additions & 68 deletions common/api-review/messaging-sw.api.md
Original file line number Diff line number Diff line change
@@ -1,68 +1,69 @@
## API Report File for "@firebase/messaging-sw"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseApp } from '@firebase/app';
import { NextFn } from '@firebase/util';
import { Observer } from '@firebase/util';
import { Unsubscribe } from '@firebase/util';

// @public
export function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

// @public
export interface FcmOptions {
analyticsLabel?: string;
link?: string;
}

// @public
export function getMessaging(app?: FirebaseApp): Messaging;

// @public
export interface GetTokenOptions {
serviceWorkerRegistration?: ServiceWorkerRegistration;
vapidKey?: string;
}

// @public
export function isSupported(): Promise<boolean>;

// @public
export interface MessagePayload {
collapseKey: string;
data?: {
[key: string]: string;
};
fcmOptions?: FcmOptions;
from: string;
messageId: string;
notification?: NotificationPayload;
}

// @public
export interface Messaging {
}

export { NextFn }

// @public
export interface NotificationPayload {
body?: string;
image?: string;
title?: string;
}

export { Observer }

// @public
export function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

export { Unsubscribe }


// (No @packageDocumentation comment for this package)

```
## API Report File for "@firebase/messaging-sw"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseApp } from '@firebase/app';
import { NextFn } from '@firebase/util';
import { Observer } from '@firebase/util';
import { Unsubscribe } from '@firebase/util';

// @public
export function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

// @public
export interface FcmOptions {
analyticsLabel?: string;
link?: string;
}

// @public
export function getMessaging(app?: FirebaseApp): Messaging;

// @public
export interface GetTokenOptions {
serviceWorkerRegistration?: ServiceWorkerRegistration;
vapidKey?: string;
}

// @public
export function isSupported(): Promise<boolean>;

// @public
export interface MessagePayload {
collapseKey: string;
data?: {
[key: string]: string;
};
fcmOptions?: FcmOptions;
from: string;
messageId: string;
notification?: NotificationPayload;
}

// @public
export interface Messaging {
app: FirebaseApp;
}

export { NextFn }

// @public
export interface NotificationPayload {
body?: string;
image?: string;
title?: string;
}

export { Observer }

// @public
export function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

export { Unsubscribe }


// (No @packageDocumentation comment for this package)

```
139 changes: 70 additions & 69 deletions common/api-review/messaging.api.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,70 @@
## API Report File for "@firebase/messaging"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseApp } from '@firebase/app';
import { NextFn } from '@firebase/util';
import { Observer } from '@firebase/util';
import { Unsubscribe } from '@firebase/util';

// @public
export function deleteToken(messaging: Messaging): Promise<boolean>;

// @public
export interface FcmOptions {
analyticsLabel?: string;
link?: string;
}

// @public
export function getMessaging(app?: FirebaseApp): Messaging;

// @public
export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

// @public
export interface GetTokenOptions {
serviceWorkerRegistration?: ServiceWorkerRegistration;
vapidKey?: string;
}

// @public
export function isSupported(): Promise<boolean>;

// @public
export interface MessagePayload {
collapseKey: string;
data?: {
[key: string]: string;
};
fcmOptions?: FcmOptions;
from: string;
messageId: string;
notification?: NotificationPayload;
}

// @public
export interface Messaging {
}

export { NextFn }

// @public
export interface NotificationPayload {
body?: string;
image?: string;
title?: string;
}

export { Observer }

// @public
export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

export { Unsubscribe }


```
## API Report File for "@firebase/messaging"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseApp } from '@firebase/app';
import { NextFn } from '@firebase/util';
import { Observer } from '@firebase/util';
import { Unsubscribe } from '@firebase/util';

// @public
export function deleteToken(messaging: Messaging): Promise<boolean>;

// @public
export interface FcmOptions {
analyticsLabel?: string;
link?: string;
}

// @public
export function getMessaging(app?: FirebaseApp): Messaging;

// @public
export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

// @public
export interface GetTokenOptions {
serviceWorkerRegistration?: ServiceWorkerRegistration;
vapidKey?: string;
}

// @public
export function isSupported(): Promise<boolean>;

// @public
export interface MessagePayload {
collapseKey: string;
data?: {
[key: string]: string;
};
fcmOptions?: FcmOptions;
from: string;
messageId: string;
notification?: NotificationPayload;
}

// @public
export interface Messaging {
app: FirebaseApp;
}

export { NextFn }

// @public
export interface NotificationPayload {
body?: string;
image?: string;
title?: string;
}

export { Observer }

// @public
export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

export { Unsubscribe }


```
Loading