Skip to content

Commit 06637ce

Browse files
authored
Merge dc44de0 into 7818176
2 parents 7818176 + dc44de0 commit 06637ce

File tree

11 files changed

+109
-74
lines changed

11 files changed

+109
-74
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export function applyActionCode(auth: Auth, oobCode: string): Promise<void>;
8080

8181
// @public
8282
export interface Auth {
83+
readonly app: FirebaseApp;
8384
readonly config: Config;
8485
readonly currentUser: User | null;
8586
readonly emulatorConfig: EmulatorConfig | null;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ export type IdChangeUnsubscribeFn = () => void;
3232

3333
// @public
3434
export interface Installations {
35+
app: FirebaseApp;
3536
}
3637

3738
// @public
Lines changed: 70 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,70 @@
1-
## API Report File for "@firebase/messaging-exp"
2-
3-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4-
5-
```ts
6-
7-
import { FirebaseApp } from '@firebase/app-exp';
8-
import { NextFn } from '@firebase/util';
9-
import { Observer } from '@firebase/util';
10-
import { Unsubscribe } from '@firebase/util';
11-
12-
// @public
13-
export function deleteToken(messaging: Messaging): Promise<boolean>;
14-
15-
// @public
16-
export interface FcmOptions {
17-
analyticsLabel?: string;
18-
link?: string;
19-
}
20-
21-
// @public
22-
export function getMessaging(app?: FirebaseApp): Messaging;
23-
24-
// @public
25-
export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
26-
27-
// @public
28-
export interface GetTokenOptions {
29-
serviceWorkerRegistration?: ServiceWorkerRegistration;
30-
vapidKey?: string;
31-
}
32-
33-
// @public
34-
export function isSupported(): Promise<boolean>;
35-
36-
// @public
37-
export interface MessagePayload {
38-
collapseKey: string;
39-
data?: {
40-
[key: string]: string;
41-
};
42-
fcmOptions?: FcmOptions;
43-
from: string;
44-
messageId: string;
45-
notification?: NotificationPayload;
46-
}
47-
48-
// @public
49-
export interface Messaging {
50-
}
51-
52-
export { NextFn }
53-
54-
// @public
55-
export interface NotificationPayload {
56-
body?: string;
57-
image?: string;
58-
title?: string;
59-
}
60-
61-
export { Observer }
62-
63-
// @public
64-
export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
65-
66-
export { Unsubscribe }
67-
68-
69-
```
1+
## API Report File for "@firebase/messaging-exp"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { FirebaseApp } from '@firebase/app-exp';
8+
import { NextFn } from '@firebase/util';
9+
import { Observer } from '@firebase/util';
10+
import { Unsubscribe } from '@firebase/util';
11+
12+
// @public
13+
export function deleteToken(messaging: Messaging): Promise<boolean>;
14+
15+
// @public
16+
export interface FcmOptions {
17+
analyticsLabel?: string;
18+
link?: string;
19+
}
20+
21+
// @public
22+
export function getMessaging(app?: FirebaseApp): Messaging;
23+
24+
// @public
25+
export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
26+
27+
// @public
28+
export interface GetTokenOptions {
29+
serviceWorkerRegistration?: ServiceWorkerRegistration;
30+
vapidKey?: string;
31+
}
32+
33+
// @public
34+
export function isSupported(): Promise<boolean>;
35+
36+
// @public
37+
export interface MessagePayload {
38+
collapseKey: string;
39+
data?: {
40+
[key: string]: string;
41+
};
42+
fcmOptions?: FcmOptions;
43+
from: string;
44+
messageId: string;
45+
notification?: NotificationPayload;
46+
}
47+
48+
// @public
49+
export interface Messaging {
50+
app: FirebaseApp;
51+
}
52+
53+
export { NextFn }
54+
55+
// @public
56+
export interface NotificationPayload {
57+
body?: string;
58+
image?: string;
59+
title?: string;
60+
}
61+
62+
export { Observer }
63+
64+
// @public
65+
export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
66+
67+
export { Unsubscribe }
68+
69+
70+
```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { FirebaseApp } from '@firebase/app-exp';
88

99
// @public
1010
export interface FirebasePerformance {
11+
app: FirebaseApp;
1112
dataCollectionEnabled: boolean;
1213
instrumentationEnabled: boolean;
1314
}

common/api-review/remote-config-exp.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export type LogLevel = 'debug' | 'error' | 'silent';
4444

4545
// @public
4646
export interface RemoteConfig {
47+
app: FirebaseApp;
4748
defaultConfig: {
4849
[key: string]: string | number | boolean;
4950
};

packages-exp/auth-exp/src/model/public_types.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18+
import { FirebaseApp } from '@firebase/app-exp';
1819
import {
1920
CompleteFn,
2021
ErrorFn,
@@ -170,12 +171,14 @@ export interface AuthSettings {
170171
* @public
171172
*/
172173
export interface Auth {
173-
/** The name of the app associated with the Auth service instance. */
174+
/** The {@link @firebase/app#FirebaseApp} associated with the `Auth` service instance. */
175+
readonly app: FirebaseApp;
176+
/** The name of the app associated with the `Auth` service instance. */
174177
readonly name: string;
175178
/** The {@link Config} used to initialize this instance. */
176179
readonly config: Config;
177180
/**
178-
* Changes the type of persistence on the {@link Auth} instance.
181+
* Changes the type of persistence on the `Auth` instance.
179182
*
180183
* @remarks
181184
* This will affect the currently saved Auth session and applies this type of persistence for

packages-exp/installations-exp/src/interfaces/public-types.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,19 @@
1515
* limitations under the License.
1616
*/
1717

18+
import { FirebaseApp } from '@firebase/app-exp';
19+
1820
/**
1921
* Public interface of the Firebase Installations SDK.
2022
*
2123
* @public
2224
*/
23-
export interface Installations {}
25+
export interface Installations {
26+
/**
27+
* The {@link @firebase/app#FirebaseApp} this `Installations` instance is associated with.
28+
*/
29+
app: FirebaseApp;
30+
}
2431

2532
/**
2633
* An interface for Firebase internal SDKs use only.

packages-exp/messaging-exp/src/interfaces/public-types.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
* limitations under the License.
1616
*/
1717

18+
import { FirebaseApp } from '@firebase/app-exp';
19+
1820
/**
1921
* Display notification details. They are sent through the
2022
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
@@ -131,7 +133,12 @@ export interface GetTokenOptions {
131133
*
132134
* @public
133135
*/
134-
export interface Messaging {}
136+
export interface Messaging {
137+
/**
138+
* The {@link @firebase/app#FirebaseApp} this `Messaging` instance is associated with.
139+
*/
140+
app: FirebaseApp;
141+
}
135142

136143
/**
137144
* @internal

packages-exp/performance-exp/src/public_types.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
* limitations under the License.
1616
*/
1717

18+
import { FirebaseApp } from '@firebase/app-exp';
19+
1820
/**
1921
* Defines configuration options for the Performance Monitoring SDK.
2022
*
@@ -34,6 +36,11 @@ export interface PerformanceSettings {
3436
* @public
3537
*/
3638
export interface FirebasePerformance {
39+
/**
40+
* The {@link @firebase/app#FirebaseApp} this `FirebasePerformance` instance is associated with.
41+
*/
42+
app: FirebaseApp;
43+
3744
/**
3845
* Controls the logging of automatic traces and HTTP/S network monitoring.
3946
*/

packages-exp/remote-config-exp/src/public_types.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,18 @@
1515
* limitations under the License.
1616
*/
1717

18+
import { FirebaseApp } from '@firebase/app-exp';
19+
1820
/**
1921
* The Firebase Remote Config service interface.
2022
*
2123
* @public
2224
*/
2325
export interface RemoteConfig {
26+
/**
27+
* The {@link @firebase/app#FirebaseApp} this `RemoteConfig` instance is associated with.
28+
*/
29+
app: FirebaseApp;
2430
/**
2531
* Defines configuration for the Remote Config SDK.
2632
*/

packages/storage/exp/public-types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import {
3131
*/
3232
export interface FirebaseStorage extends _FirebaseService {
3333
/**
34-
* FirebaseApp associated with this StorageService instance.
34+
* The `FirebaseApp` associated with this `FirebaseStorage` instance.
3535
*/
3636
readonly app: FirebaseApp;
3737

0 commit comments

Comments
 (0)