Skip to content

Commit a6a7b16

Browse files
committed
Remove @firebase/messaging-types
Moves messaging types to an interface within the messaging package. Closes #526.
1 parent 4196fab commit a6a7b16

File tree

9 files changed

+13
-48
lines changed

9 files changed

+13
-48
lines changed

.github/CODEOWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ packages/storage-types @sphippen
2020

2121
# Messaging Code
2222
packages/messaging @gauntface @pinarx @mmermerkaya @alecmce @dwoffinden
23-
packages/messaging-types @gauntface @pinarx @mmermerkaya @alecmce @dwoffinden
2423
integration/messaging @gauntface @pinarx @mmermerkaya @alecmce @dwoffinden
2524

2625
# Auth Code

packages/functions/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@
6464
"typings": "dist/index.d.ts",
6565
"dependencies": {
6666
"@firebase/functions-types": "0.1.2",
67-
"@firebase/messaging-types": "0.2.2",
6867
"isomorphic-fetch": "2.2.1"
6968
},
7069
"nyc": {

packages/functions/src/context.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import { FirebaseApp } from '@firebase/app-types';
1717
import { _FirebaseApp } from '@firebase/app-types/private';
1818
import { firebase } from '@firebase/app';
19-
import { FirebaseMessaging } from '@firebase/messaging-types';
19+
import { FirebaseMessaging } from '@firebase/messaging';
2020

2121
/**
2222
* The metadata that should be supplied with function calls.

packages/messaging-types/package.json

Lines changed: 0 additions & 26 deletions
This file was deleted.

packages/messaging-types/tsconfig.json

Lines changed: 0 additions & 9 deletions
This file was deleted.

packages/messaging/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,14 @@ import {
1919
_FirebaseNamespace,
2020
FirebaseServiceFactory
2121
} from '@firebase/app-types/private';
22-
import { FirebaseMessaging } from '@firebase/messaging-types';
2322

2423
import { SwController } from './src/controllers/sw-controller';
2524
import { WindowController } from './src/controllers/window-controller';
25+
import { FirebaseMessaging } from './src/interfaces/firebase-messaging';
2626
import { ERROR_CODES, errorFactory } from './src/models/errors';
2727

28+
export { FirebaseMessaging } from './src/interfaces/firebase-messaging';
29+
2830
export function registerMessaging(instance: _FirebaseNamespace): void {
2931
const messagingName = 'messaging';
3032

packages/messaging/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
"@firebase/app-types": "0.x"
2626
},
2727
"dependencies": {
28-
"@firebase/messaging-types": "0.2.2",
2928
"@firebase/util": "0.2.0",
3029
"tslib": "1.9.0"
3130
},

packages/messaging/src/controllers/controller-interface.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616

1717
import { FirebaseApp } from '@firebase/app-types';
1818
import { FirebaseServiceInternals } from '@firebase/app-types/private';
19-
import { FirebaseMessaging } from '@firebase/messaging-types';
2019
import {
2120
CompleteFn,
2221
ErrorFn,
@@ -26,6 +25,7 @@ import {
2625
} from '@firebase/util';
2726

2827
import { isArrayBufferEqual } from '../helpers/is-array-buffer-equal';
28+
import { FirebaseMessaging } from '../interfaces/firebase-messaging';
2929
import { MessagePayload } from '../interfaces/message-payload';
3030
import { TokenDetails } from '../interfaces/token-details';
3131
import { ERROR_CODES, errorFactory } from '../models/errors';

packages/messaging-types/index.d.ts renamed to packages/messaging/src/interfaces/firebase-messaging.ts

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,32 @@
1414
* limitations under the License.
1515
*/
1616

17-
import { FirebaseApp, FirebaseNamespace } from '@firebase/app-types';
1817
import {
19-
Observer,
20-
Unsubscribe,
21-
NextFn,
18+
CompleteFn,
2219
ErrorFn,
23-
CompleteFn
20+
NextFn,
21+
Observer,
22+
Unsubscribe
2423
} from '@firebase/util';
2524

26-
export class FirebaseMessaging {
27-
private constructor();
25+
export interface FirebaseMessaging {
2826
deleteToken(token: string): Promise<boolean>;
2927
getToken(): Promise<string | null>;
3028
onMessage(
29+
// tslint:disable-next-line no-any The message payload can be anything.
3130
nextOrObserver: NextFn<any> | Observer<any>,
3231
error?: ErrorFn,
3332
completed?: CompleteFn
3433
): Unsubscribe;
3534
onTokenRefresh(
35+
// tslint:disable-next-line no-any Not implemented yet.
3636
nextOrObserver: NextFn<any> | Observer<any>,
3737
error?: ErrorFn,
3838
completed?: CompleteFn
3939
): Unsubscribe;
4040
requestPermission(): Promise<void>;
4141
setBackgroundMessageHandler(
42+
// tslint:disable no-any The message payload can be anything.
4243
callback: (payload: any) => Promise<any> | void
4344
): void;
4445
useServiceWorker(registration: ServiceWorkerRegistration): void;

0 commit comments

Comments
 (0)