From 0f4e400630c7ce0da1eccc1a83d67a8b8005dea2 Mon Sep 17 00:00:00 2001 From: Mertcan Mermerkaya Date: Thu, 10 May 2018 11:08:56 +0100 Subject: [PATCH] Remove @firebase/messaging-types Moves messaging types to an interface within the messaging package. Closes #526. --- .github/CODEOWNERS | 1 - packages/functions/package.json | 1 - packages/functions/src/context.ts | 2 +- packages/messaging-types/package.json | 26 ------------------- packages/messaging-types/tsconfig.json | 9 ------- packages/messaging/index.ts | 4 ++- packages/messaging/package.json | 1 - .../src/controllers/controller-interface.ts | 2 +- .../src/interfaces/firebase-messaging.ts} | 15 ++++++----- 9 files changed, 13 insertions(+), 48 deletions(-) delete mode 100644 packages/messaging-types/package.json delete mode 100644 packages/messaging-types/tsconfig.json rename packages/{messaging-types/index.d.ts => messaging/src/interfaces/firebase-messaging.ts} (82%) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d392c4f2b3a..6cd158f3343 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -20,7 +20,6 @@ packages/storage-types @sphippen # Messaging Code packages/messaging @gauntface @pinarx @mmermerkaya @alecmce @dwoffinden -packages/messaging-types @gauntface @pinarx @mmermerkaya @alecmce @dwoffinden integration/messaging @gauntface @pinarx @mmermerkaya @alecmce @dwoffinden # Auth Code diff --git a/packages/functions/package.json b/packages/functions/package.json index b2d796e4b1b..8be8b769627 100644 --- a/packages/functions/package.json +++ b/packages/functions/package.json @@ -64,7 +64,6 @@ "typings": "dist/index.d.ts", "dependencies": { "@firebase/functions-types": "0.1.2", - "@firebase/messaging-types": "0.2.2", "isomorphic-fetch": "2.2.1" }, "nyc": { diff --git a/packages/functions/src/context.ts b/packages/functions/src/context.ts index 0789721d4fa..52aa723d26e 100644 --- a/packages/functions/src/context.ts +++ b/packages/functions/src/context.ts @@ -16,7 +16,7 @@ import { FirebaseApp } from '@firebase/app-types'; import { _FirebaseApp } from '@firebase/app-types/private'; import { firebase } from '@firebase/app'; -import { FirebaseMessaging } from '@firebase/messaging-types'; +import { FirebaseMessaging } from '@firebase/messaging'; /** * The metadata that should be supplied with function calls. diff --git a/packages/messaging-types/package.json b/packages/messaging-types/package.json deleted file mode 100644 index cb4ad93a423..00000000000 --- a/packages/messaging-types/package.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "name": "@firebase/messaging-types", - "version": "0.2.2", - "description": "@firebase/messaging Types", - "author": "Firebase (https://firebase.google.com/)", - "license": "Apache-2.0", - "scripts": { - "test": "tsc" - }, - "files": [ - "index.d.ts" - ], - "peerDependencies": { - "@firebase/app-types": "0.x" - }, - "repository": { - "type": "git", - "url": "https://github.com/firebase/firebase-js-sdk/tree/master/packages/messaging-types" - }, - "bugs": { - "url": "https://github.com/firebase/firebase-js-sdk/issues" - }, - "devDependencies": { - "typescript": "2.8.1" - } -} diff --git a/packages/messaging-types/tsconfig.json b/packages/messaging-types/tsconfig.json deleted file mode 100644 index 9a785433d90..00000000000 --- a/packages/messaging-types/tsconfig.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "extends": "../../config/tsconfig.base.json", - "compilerOptions": { - "noEmit": true - }, - "exclude": [ - "dist/**/*" - ] -} diff --git a/packages/messaging/index.ts b/packages/messaging/index.ts index 633ec446b7d..9e8e756dc51 100644 --- a/packages/messaging/index.ts +++ b/packages/messaging/index.ts @@ -19,12 +19,14 @@ import { _FirebaseNamespace, FirebaseServiceFactory } from '@firebase/app-types/private'; -import { FirebaseMessaging } from '@firebase/messaging-types'; import { SwController } from './src/controllers/sw-controller'; import { WindowController } from './src/controllers/window-controller'; +import { FirebaseMessaging } from './src/interfaces/firebase-messaging'; import { ERROR_CODES, errorFactory } from './src/models/errors'; +export { FirebaseMessaging } from './src/interfaces/firebase-messaging'; + export function registerMessaging(instance: _FirebaseNamespace): void { const messagingName = 'messaging'; diff --git a/packages/messaging/package.json b/packages/messaging/package.json index e72e9136ee8..5e2a3b86413 100644 --- a/packages/messaging/package.json +++ b/packages/messaging/package.json @@ -25,7 +25,6 @@ "@firebase/app-types": "0.x" }, "dependencies": { - "@firebase/messaging-types": "0.2.2", "@firebase/util": "0.2.0", "tslib": "1.9.0" }, diff --git a/packages/messaging/src/controllers/controller-interface.ts b/packages/messaging/src/controllers/controller-interface.ts index 89001ff6fd0..4a1233a0b29 100644 --- a/packages/messaging/src/controllers/controller-interface.ts +++ b/packages/messaging/src/controllers/controller-interface.ts @@ -16,7 +16,6 @@ import { FirebaseApp } from '@firebase/app-types'; import { FirebaseServiceInternals } from '@firebase/app-types/private'; -import { FirebaseMessaging } from '@firebase/messaging-types'; import { CompleteFn, ErrorFn, @@ -26,6 +25,7 @@ import { } from '@firebase/util'; import { isArrayBufferEqual } from '../helpers/is-array-buffer-equal'; +import { FirebaseMessaging } from '../interfaces/firebase-messaging'; import { MessagePayload } from '../interfaces/message-payload'; import { TokenDetails } from '../interfaces/token-details'; import { ERROR_CODES, errorFactory } from '../models/errors'; diff --git a/packages/messaging-types/index.d.ts b/packages/messaging/src/interfaces/firebase-messaging.ts similarity index 82% rename from packages/messaging-types/index.d.ts rename to packages/messaging/src/interfaces/firebase-messaging.ts index 34b09a62083..0ea1460aaa6 100644 --- a/packages/messaging-types/index.d.ts +++ b/packages/messaging/src/interfaces/firebase-messaging.ts @@ -14,31 +14,32 @@ * limitations under the License. */ -import { FirebaseApp, FirebaseNamespace } from '@firebase/app-types'; import { - Observer, - Unsubscribe, - NextFn, + CompleteFn, ErrorFn, - CompleteFn + NextFn, + Observer, + Unsubscribe } from '@firebase/util'; -export class FirebaseMessaging { - private constructor(); +export interface FirebaseMessaging { deleteToken(token: string): Promise; getToken(): Promise; onMessage( + // tslint:disable-next-line no-any The message payload can be anything. nextOrObserver: NextFn | Observer, error?: ErrorFn, completed?: CompleteFn ): Unsubscribe; onTokenRefresh( + // tslint:disable-next-line no-any Not implemented yet. nextOrObserver: NextFn | Observer, error?: ErrorFn, completed?: CompleteFn ): Unsubscribe; requestPermission(): Promise; setBackgroundMessageHandler( + // tslint:disable no-any The message payload can be anything. callback: (payload: any) => Promise | void ): void; useServiceWorker(registration: ServiceWorkerRegistration): void;