Skip to content

Commit e812c16

Browse files
committed
update installations type
1 parent 6564e99 commit e812c16

File tree

8 files changed

+23
-27
lines changed

8 files changed

+23
-27
lines changed

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,7 @@
77
import { FirebaseApp } from '@firebase/app-exp';
88

99
// @public
10-
export function deleteInstallations(installations: FirebaseInstallations): Promise<void>;
11-
12-
// @public
13-
export interface FirebaseInstallations {
14-
}
10+
export function deleteInstallations(installations: Installations): Promise<void>;
1511

1612
// @internal
1713
export interface _FirebaseInstallationsInternal {
@@ -20,13 +16,13 @@ export interface _FirebaseInstallationsInternal {
2016
}
2117

2218
// @public
23-
export function getId(installations: FirebaseInstallations): Promise<string>;
19+
export function getId(installations: Installations): Promise<string>;
2420

2521
// @public
26-
export function getInstallations(app?: FirebaseApp): FirebaseInstallations;
22+
export function getInstallations(app?: FirebaseApp): Installations;
2723

2824
// @public
29-
export function getToken(installations: FirebaseInstallations, forceRefresh?: boolean): Promise<string>;
25+
export function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
3026

3127
// @public
3228
export type IdChangeCallbackFn = (installationId: string) => void;
@@ -35,7 +31,11 @@ export type IdChangeCallbackFn = (installationId: string) => void;
3531
export type IdChangeUnsubscribeFn = () => void;
3632

3733
// @public
38-
export function onIdChange(installations: FirebaseInstallations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
34+
export interface Installations {
35+
}
36+
37+
// @public
38+
export function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
3939

4040

4141
```

packages-exp/installations-exp/src/api/delete-installations.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { remove, update } from '../helpers/idb-manager';
2020
import { RequestStatus } from '../interfaces/installation-entry';
2121
import { ERROR_FACTORY, ErrorCode } from '../util/errors';
2222
import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
23-
import { FirebaseInstallations } from '../interfaces/public-types';
23+
import { Installations } from '../interfaces/public-types';
2424

2525
/**
2626
* Deletes the Firebase Installation and all associated data.
@@ -29,7 +29,7 @@ import { FirebaseInstallations } from '../interfaces/public-types';
2929
* @public
3030
*/
3131
export async function deleteInstallations(
32-
installations: FirebaseInstallations
32+
installations: Installations
3333
): Promise<void> {
3434
const { appConfig } = installations as FirebaseInstallationsImpl;
3535

packages-exp/installations-exp/src/api/get-id.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import { getInstallationEntry } from '../helpers/get-installation-entry';
1919
import { refreshAuthToken } from '../helpers/refresh-auth-token';
2020
import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
21-
import { FirebaseInstallations } from '../interfaces/public-types';
21+
import { Installations } from '../interfaces/public-types';
2222

2323
/**
2424
* Creates a Firebase Installation if there isn't one for the app and
@@ -27,9 +27,7 @@ import { FirebaseInstallations } from '../interfaces/public-types';
2727
*
2828
* @public
2929
*/
30-
export async function getId(
31-
installations: FirebaseInstallations
32-
): Promise<string> {
30+
export async function getId(installations: Installations): Promise<string> {
3331
const installationsImpl = installations as FirebaseInstallationsImpl;
3432
const { installationEntry, registrationPromise } = await getInstallationEntry(
3533
installationsImpl.appConfig

packages-exp/installations-exp/src/api/get-installations.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,15 @@
1616
*/
1717

1818
import { FirebaseApp, getApp, _getProvider } from '@firebase/app-exp';
19-
import { FirebaseInstallations } from '../interfaces/public-types';
19+
import { Installations } from '../interfaces/public-types';
2020

2121
/**
2222
* Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance.
2323
* @param app - The `FirebaseApp` instance.
2424
*
2525
* @public
2626
*/
27-
export function getInstallations(
28-
app: FirebaseApp = getApp()
29-
): FirebaseInstallations {
27+
export function getInstallations(app: FirebaseApp = getApp()): Installations {
3028
const installationsImpl = _getProvider(
3129
app,
3230
'installations-exp'

packages-exp/installations-exp/src/api/get-token.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
FirebaseInstallationsImpl,
2222
AppConfig
2323
} from '../interfaces/installation-impl';
24-
import { FirebaseInstallations } from '../interfaces/public-types';
24+
import { Installations } from '../interfaces/public-types';
2525

2626
/**
2727
* Returns an Installation auth token, identifying the current Firebase Installation.
@@ -31,7 +31,7 @@ import { FirebaseInstallations } from '../interfaces/public-types';
3131
* @public
3232
*/
3333
export async function getToken(
34-
installations: FirebaseInstallations,
34+
installations: Installations,
3535
forceRefresh = false
3636
): Promise<string> {
3737
const installationsImpl = installations as FirebaseInstallationsImpl;

packages-exp/installations-exp/src/api/on-id-change.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import { addCallback, removeCallback } from '../helpers/fid-changed';
1919
import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
20-
import { FirebaseInstallations } from '../interfaces/public-types';
20+
import { Installations } from '../interfaces/public-types';
2121

2222
/**
2323
* An user defined callback function that gets called when Installations ID changes.
@@ -42,7 +42,7 @@ export type IdChangeUnsubscribeFn = () => void;
4242
* @public
4343
*/
4444
export function onIdChange(
45-
installations: FirebaseInstallations,
45+
installations: Installations,
4646
callback: IdChangeCallbackFn
4747
): IdChangeUnsubscribeFn {
4848
const { appConfig } = installations as FirebaseInstallationsImpl;

packages-exp/installations-exp/src/interfaces/installation-impl.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717

1818
import { Provider } from '@firebase/component';
1919
import { _FirebaseService } from '@firebase/app-exp';
20-
import { FirebaseInstallations } from '../interfaces/public-types';
20+
import { Installations } from '../interfaces/public-types';
2121

2222
export interface FirebaseInstallationsImpl
23-
extends FirebaseInstallations,
23+
extends Installations,
2424
_FirebaseService {
2525
readonly appConfig: AppConfig;
2626
readonly platformLoggerProvider: Provider<'platform-logger'>;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
*
2121
* @public
2222
*/
23-
export interface FirebaseInstallations {}
23+
export interface Installations {}
2424

2525
/**
2626
* An interface for Firebase internal SDKs use only.
@@ -43,7 +43,7 @@ export interface _FirebaseInstallationsInternal {
4343

4444
declare module '@firebase/component' {
4545
interface NameServiceMapping {
46-
'installations-exp': FirebaseInstallations;
46+
'installations-exp': Installations;
4747
'installations-exp-internal': _FirebaseInstallationsInternal;
4848
}
4949
}

0 commit comments

Comments
 (0)