Allow FCM to auto-generate typings, separate internal vs external APIs

src/messaging/index.ts

@@ -0,0 +1,41 @@
+/*!
+ * Copyright 2020 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FirebaseApp } from '../firebase-app';
+import * as messagingApi from './messaging';
+import * as firebaseAdmin from '../index';
+
+export function messaging(app?: FirebaseApp): messagingApi.Messaging {
+  if (typeof(app) === 'undefined') {
+    app = firebaseAdmin.app();
+  }
+  return app.messaging();
+}
+
+/**
+ * We must define a namespace to make the typings work correctly. Otherwise
+ * `admin.messaging()` cannot be called like a function. Temporarily,
+ * admin.messaging is used as the namespace name because we cannot barrel 
+ * re-export the contents from messsaging, and we want it to
+ * match the namespacing in the re-export inside src/index.d.ts
+ */
+/* eslint-disable @typescript-eslint/no-namespace */
+export namespace admin.messaging {
+  // See https://github.com/microsoft/TypeScript/issues/4336
+  // Allows for exposing classes as interfaces in typings
+  /* eslint-disable @typescript-eslint/no-empty-interface */
+  export interface Messaging extends messagingApi.Messaging {}
+}

src/messaging/messaging-api-request.ts → src/messaging/messaging-api-request-internal.ts

@@ -18,8 +18,8 @@ import { FirebaseApp } from '../firebase-app';
 import {
   HttpMethod, AuthorizedHttpClient, HttpRequestConfig, HttpError, HttpResponse,
 } from '../utils/api-request';
-import { createFirebaseError, getErrorCode } from './messaging-errors';
-import { SubRequest, BatchRequestClient } from './batch-request';
+import { createFirebaseError, getErrorCode } from './messaging-errors-internal';
+import { SubRequest, BatchRequestClient } from './batch-request-internal';
 import { SendResponse, BatchResponse } from './messaging-types';
 import { getSdkVersion } from '../utils/index';
 
@@ -35,7 +35,6 @@ const LEGACY_FIREBASE_MESSAGING_HEADERS = {
   'access_token_auth': 'true',
 };
 
-
 /**
  * Class that provides a mechanism to send requests to the Firebase Cloud Messaging backend.
  */

src/messaging/messaging-internal.ts

@@ -0,0 +1,23 @@
+/*!
+ * Copyright 2020 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// Keys which are not allowed in the messaging data payload object.
+export const BLACKLISTED_DATA_PAYLOAD_KEYS = ['from'];
+
+// Keys which are not allowed in the messaging options object.
+export const BLACKLISTED_OPTIONS_KEYS = [
+  'condition', 'data', 'notification', 'registrationIds', 'registration_ids', 'to',
+];