Add entry point firebase/messaging/sw (#4938)

* generate reports for the sw entry point

* remove unneeded scripts

* add entry point firebase/messaging/sw

* update verbiage

Author: Feiyang1

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

@@ -29,10 +29,13 @@ export type _FirebaseMessagingName = 'messaging';
 export function getMessaging(app?: FirebaseApp): FirebaseMessaging;
 
 // @public
-export function getToken(messaging: FirebaseMessaging, options?: {
-    vapidKey?: string;
+export function getToken(messaging: FirebaseMessaging, options?: GetTokenOptions): Promise<string>;
+
+// @public
+export interface GetTokenOptions {
     swReg?: ServiceWorkerRegistration;
-}): Promise<string>;
+    vapidKey?: string;
+}
 
 // @public
 export function isSupported(): Promise<boolean>;

common/api-review/messaging-exp.sw.api.md

@@ -0,0 +1,56 @@
+## API Report File for "@firebase/messaging-exp/sw"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { FirebaseApp } from '@firebase/app-exp';
+import { NextFn } from '@firebase/util';
+import { Observer } from '@firebase/util';
+import { Unsubscribe } from '@firebase/util';
+
+// @public
+export interface FcmOptions {
+    analyticsLabel?: string;
+    link?: string;
+}
+
+// @public
+export interface FirebaseMessaging {
+}
+
+// @public
+export function getMessaging(app?: FirebaseApp): FirebaseMessaging;
+
+// @public
+export function isSupported(): Promise<boolean>;
+
+// @public
+export interface MessagePayload {
+    collapseKey: string;
+    data?: {
+        [key: string]: string;
+    };
+    fcmOptions?: FcmOptions;
+    from: string;
+    notification?: NotificationPayload;
+}
+
+export { NextFn }
+
+// @public
+export interface NotificationPayload {
+    body?: string;
+    image?: string;
+    title?: string;
+}
+
+export { Observer }
+
+// @public
+export function onBackgroundMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
+
+export { Unsubscribe }
+
+
+```

packages-exp/firebase-exp/messaging/index.sw.ts renamed to packages-exp/firebase-exp/messaging/sw/index.ts

@@ -0,0 +1,8 @@
+{
+    "name": "firebase-exp/messaging/sw",
+    "main": "dist/index.cjs.js",
+    "browser": "dist/index.esm.js",
+    "module": "dist/index.esm.js",
+    "typings": "dist/messaging/sw/index.d.ts"
+  }
+  

packages-exp/firebase-exp/messaging/sw/package.json

@@ -114,8 +114,8 @@
     "url": "https://github.com/firebase/firebase-js-sdk.git"
   },
   "scripts": {
-    "build": "rollup -c && gulp firebase-js && yarn build:compat",
-    "build:release": "rollup -c rollup.config.release.js && gulp firebase-js && yarn build:compat:release",
+    "build": "rollup -c && yarn build:compat",
+    "build:release": "rollup -c rollup.config.release.js && yarn build:compat:release",
     "build:compat": "rollup -c compat/rollup.config.js",
     "build:compat:release": "rollup -c compat/rollup.config.release.js",
     "dev": "rollup -c -w",
@@ -167,6 +167,7 @@
     "performance",
     "remote-config",
     "messaging",
+    "messaging/sw",
     "database"
   ]
 }

packages-exp/firebase-exp/package.json

@@ -24,72 +24,14 @@ import resolveModule from '@rollup/plugin-node-resolve';
 import rollupTypescriptPlugin from 'rollup-plugin-typescript2';
 import sourcemaps from 'rollup-plugin-sourcemaps';
 import typescript from 'typescript';
-import { uglify } from 'rollup-plugin-uglify';
 
 const external = Object.keys(pkg.dependencies || {});
-
-/**
- * Global UMD Build
- */
-const GLOBAL_NAME = 'firebase';
-
-function createUmdOutputConfig(output, componentName) {
-  return {
-    file: output,
-    format: 'umd',
-    sourcemap: true,
-    extend: true,
-    name: `${GLOBAL_NAME}.${camelize(componentName)}`,
-    globals: {
-      '@firebase/app-exp': `${GLOBAL_NAME}.app`
-    },
-
-    /**
-     * use iife to avoid below error in the old Safari browser
-     * SyntaxError: Functions cannot be declared in a nested block in strict mode
-     * https://github.com/firebase/firebase-js-sdk/issues/1228
-     *
-     */
-    intro: `
-          try {
-            (function() {`,
-    outro: `
-          }).apply(this, arguments);
-        } catch(err) {
-            console.error(err);
-            throw new Error(
-              'Cannot instantiate ${output} - ' +
-              'be sure to load firebase-app.js first.'
-            );
-          }`
-  };
-}
-
-function camelize(str) {
-  const arr = str.split('-');
-  const capital = arr.map((item, index) =>
-    index > 0
-      ? item.charAt(0).toUpperCase() + item.slice(1).toLowerCase()
-      : item.toLowerCase()
-  );
-  return capital.join('');
-}
-
 const plugins = [sourcemaps(), resolveModule(), json(), commonjs()];
 
 const typescriptPlugin = rollupTypescriptPlugin({
   typescript
 });
 
-const typescriptPluginUMD = rollupTypescriptPlugin({
-  typescript,
-  tsconfigOverride: {
-    compilerOptions: {
-      declaration: false
-    }
-  }
-});
-
 /**
  * Individual Component Builds
  */
@@ -105,19 +47,6 @@ const appBuilds = [
     ],
     plugins: [...plugins, typescriptPlugin],
     external
-  },
-  /**
-   * App UMD Builds
-   */
-  {
-    input: 'app/index.cdn.ts',
-    output: {
-      file: 'firebase-app.js',
-      sourcemap: true,
-      format: 'umd',
-      name: `${GLOBAL_NAME}.app`
-    },
-    plugins: [...plugins, typescriptPluginUMD, uglify()]
   }
 ];
 
@@ -126,50 +55,6 @@ const componentBuilds = pkg.components
   .filter(component => component !== 'app')
   .map(component => {
     const pkg = require(`./${component}/package.json`);
-    // It is needed for handling sub modules, for example firestore/lite which should produce firebase-firestore-lite.js
-    // Otherwise, we will create a directory with '/' in the name.
-    const componentName = component.replace('/', '-');
-
-    if (component === 'messaging') {
-      return [
-        {
-          input: `${component}/index.ts`,
-          output: [
-            {
-              file: resolve(component, pkg.main),
-              format: 'cjs',
-              sourcemap: true
-            },
-            {
-              file: resolve(component, pkg.module),
-              format: 'es',
-              sourcemap: true
-            }
-          ],
-          plugins: [...plugins, typescriptPlugin],
-          external
-        },
-        {
-          input: `${component}/index.ts`,
-          output: createUmdOutputConfig(
-            `firebase-${componentName}.js`,
-            componentName
-          ),
-          plugins: [...plugins, typescriptPluginUMD, uglify()],
-          external: ['@firebase/app-exp']
-        },
-        {
-          input: `${component}/index.sw.ts`,
-          output: createUmdOutputConfig(
-            `firebase-${componentName}-sw.js`,
-            componentName
-          ),
-          plugins: [...plugins, typescriptPluginUMD, uglify()],
-          external: ['@firebase/app-exp']
-        }
-      ];
-    }
-
     return [
       {
         input: `${component}/index.ts`,
@@ -187,15 +72,6 @@ const componentBuilds = pkg.components
         ],
         plugins: [...plugins, typescriptPlugin],
         external
-      },
-      {
-        input: `${component}/index.ts`,
-        output: createUmdOutputConfig(
-          `firebase-${componentName}.js`,
-          componentName
-        ),
-        plugins: [...plugins, typescriptPluginUMD, uglify()],
-        external: ['@firebase/app-exp']
       }
     ];
   })