Make @firebase/app-next have single entry point (firebase#2937)

* change to single entry point

* point to the public d.ts file in release build

* prefix _ for internal APIs

* [AUTOMATED]: Prettier Code Styling

* [AUTOMATED]: License Headers

Author: Feiyang1

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

@@ -4,12 +4,30 @@
 
 ```ts
 
-import { FirebaseApp } from '@firebase/app-types';
-import { FirebaseAppConfig } from '@firebase/app-types';
-import { FirebaseOptions } from '@firebase/app-types';
+import { Component } from '@firebase/component';
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { FirebaseAppConfig } from '@firebase/app-types-exp';
+import { FirebaseOptions } from '@firebase/app-types-exp';
 import { LogCallback } from '@firebase/logger';
 import { LogLevel } from '@firebase/logger';
 import { LogOptions } from '@firebase/logger';
+import { Name } from '@firebase/component';
+import { Provider } from '@firebase/component';
+
+// @internal (undocumented)
+export function _addComponent(app: FirebaseApp, component: Component): void;
+
+// @internal (undocumented)
+export function _addOrOverwriteComponent(app: FirebaseApp, component: Component): void;
+
+// @internal (undocumented)
+export const _apps: Map<string, FirebaseApp>;
+
+// @internal
+export function _clearComponents(): void;
+
+// @internal
+export const _components: Map<string, Component<any>>;
 
 // @public
 export function deleteApp(app: FirebaseApp): Promise<void>;
@@ -20,6 +38,9 @@ export function getApp(name?: string): FirebaseApp;
 // @public
 export function getApps(): FirebaseApp[];
 
+// @internal (undocumented)
+export function _getProvider<T extends Name>(app: FirebaseApp, name: T): Provider<T>;
+
 // @public
 export function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
 
@@ -31,6 +52,9 @@ export { LogLevel }
 // @public
 export function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
 
+// @internal (undocumented)
+export function _registerComponent(component: Component): boolean;
+
 // @public
 export function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
 

config/api-extractor.json

@@ -184,7 +184,7 @@
     /**
      * (REQUIRED) Whether to generate the .d.ts rollup file.
      */
-    "enabled": true,
+    "enabled": false,
 
     /**
      * Specifies the output path for a .d.ts rollup file to be generated without any trimming.

packages-exp/app-exp/api-extractor.json

@@ -1,5 +1,10 @@
 {
     "extends": "../../config/api-extractor.json",
     // Point it to your entry point d.ts file. 
-    "mainEntryPointFilePath": "<projectFolder>/dist/esm5/packages-exp/app-exp/src/index.d.ts"
+    "mainEntryPointFilePath": "<projectFolder>/dist/packages-exp/app-exp/src/index.d.ts",
+    "dtsRollup": {
+        "enabled": true,
+        "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
+        "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
+    }
 }

packages-exp/app-exp/internal/package.json

@@ -4,18 +4,18 @@
   "private": true,
   "description": "FirebaseApp",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
-  "main": "dist/cjs/index.js",
-  "browser": "dist/esm5/index.js",
-  "module": "dist/esm5/index.js",
-  "esm2017": "dist/esm2017/index.js",
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm5.js",
+  "module": "dist/index.esm5.js",
+  "esm2017": "dist/index.esm2017.js",
   "files": [
     "dist"
   ],
   "scripts": {
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
-    "build": "rollup -c",
-    "build:release": "rollup -c rollup.config.release.js",
+    "build": "rollup -c && yarn api-report",
+    "build:release": "rollup -c rollup.config.release.js && yarn api-report && node ./use_public_typings.js",
     "build:deps": "lerna run --scope @firebase/app-exp --include-dependencies build",
     "dev": "rollup -c -w",
     "test": "yarn type-check && run-p lint test:browser test:node",
@@ -26,7 +26,7 @@
     "api-report": "api-extractor run --local --verbose",
     "predoc": "node ../../scripts/exp/remove-exp.js temp",
     "doc": "api-documenter markdown --input temp --output docs",
-    "build:doc": "yarn build && yarn api-report && yarn doc"
+    "build:doc": "yarn build && yarn doc"
   },
   "dependencies": {
     "@firebase/app-types-exp": "0.800.0",
@@ -51,7 +51,7 @@
   "bugs": {
     "url": "https://github.com/firebase/firebase-js-sdk/issues"
   },
-  "typings": "dist/esm5/packages-exp/app-exp/src/index.d.ts",
+  "typings": "./dist/app-exp.d.ts",
   "nyc": {
     "extension": [
       ".ts"

packages-exp/app-exp/package.json

@@ -39,23 +39,17 @@ const es5Builds = [
    * Browser Builds
    */
   {
-    input: {
-      index: 'src/index.ts',
-      internal: 'src/internal.ts'
-    },
-    output: [{ dir: 'dist/esm5', format: 'es', sourcemap: true }],
+    input: 'src/index.ts',
+    output: [{ file: pkg.browser, format: 'es', sourcemap: true }],
     plugins: es5BuildPlugins,
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   },
   /**
    * Node.js Build
    */
   {
-    input: {
-      index: 'src/index.ts',
-      internal: 'src/internal.ts'
-    },
-    output: [{ dir: 'dist/cjs', format: 'cjs', sourcemap: true }],
+    input: 'src/index.ts',
+    output: [{ file: pkg.main, format: 'cjs', sourcemap: true }],
     plugins: es5BuildPlugins,
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
   }
@@ -83,12 +77,9 @@ const es2017Builds = [
    *  Browser Builds
    */
   {
-    input: {
-      index: 'src/index.ts',
-      internal: 'src/internal.ts'
-    },
+    input: 'src/index.ts',
     output: {
-      dir: 'dist/esm2017',
+      file: pkg.esm2017,
       format: 'es',
       sourcemap: true
     },

packages-exp/app-exp/rollup.config.js

@@ -42,11 +42,8 @@ const es5Builds = [
    * Browser Builds
    */
   {
-    input: {
-      index: 'src/index.ts',
-      internal: 'src/internal.ts'
-    },
-    output: [{ dir: 'dist/esm5', format: 'es', sourcemap: true }],
+    input: 'src/index.ts',
+    output: [{ file: pkg.browser, format: 'es', sourcemap: true }],
     plugins: es5BuildPlugins,
     external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)),
     treeshake: {
@@ -57,13 +54,13 @@ const es5Builds = [
    * Node.js Build
    */
   {
-    input: {
-      index: 'src/index.ts',
-      internal: 'src/internal.ts'
-    },
-    output: [{ dir: 'dist/cjs', format: 'cjs', sourcemap: true }],
+    input: 'src/index.ts',
+    output: [{ file: pkg.main, format: 'cjs', sourcemap: true }],
     plugins: es5BuildPlugins,
-    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)),
+    treeshake: {
+      moduleSideEffects: false
+    }
   }
 ];
 
@@ -91,17 +88,17 @@ const es2017Builds = [
    *  Browser Builds
    */
   {
-    input: {
-      index: 'src/index.ts',
-      internal: 'src/internal.ts'
-    },
+    input: 'src/index.ts',
     output: {
-      dir: 'dist/esm2017',
+      file: pkg.esm2017,
       format: 'es',
       sourcemap: true
     },
     plugins: es2017BuildPlugins,
-    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`)),
+    treeshake: {
+      moduleSideEffects: false
+    }
   }
 ];
 

packages-exp/app-exp/rollup.config.release.js

@@ -31,10 +31,10 @@ import {
 import { DEFAULT_ENTRY_NAME } from './constants';
 import { _FirebaseAppInternal } from '@firebase/app-types-exp';
 import {
-  clearComponents,
-  components,
-  registerComponent,
-  getProvider
+  _clearComponents,
+  _components,
+  _registerComponent,
+  _getProvider
 } from './internal';
 import { createTestComponent } from '../test/util';
 import { Component, ComponentType } from '@firebase/component';
@@ -103,15 +103,17 @@ describe('API tests', () => {
     });
 
     it('adds registered components to App', () => {
-      clearComponents();
+      _clearComponents();
       const comp1 = createTestComponent('test1');
       const comp2 = createTestComponent('test2');
-      registerComponent(comp1);
-      registerComponent(comp2);
+      _registerComponent(comp1);
+      _registerComponent(comp2);
 
       const app = initializeApp({}) as _FirebaseAppInternal;
       // -1 here to not count the FirebaseApp provider that's added during initializeApp
-      expect(app.container.getProviders().length - 1).to.equal(components.size);
+      expect(app.container.getProviders().length - 1).to.equal(
+        _components.size
+      );
     });
   });
 
@@ -177,57 +179,57 @@ describe('API tests', () => {
 
   describe('registerVersion', () => {
     afterEach(() => {
-      clearComponents();
+      _clearComponents();
     });
 
     it('will register an official version component without warnings', () => {
       const warnStub = stub(console, 'warn');
-      const initialSize = components.size;
+      const initialSize = _components.size;
 
       registerVersion('@firebase/analytics', '1.2.3');
-      expect(components.get('fire-analytics-version')).to.exist;
-      expect(components.size).to.equal(initialSize + 1);
+      expect(_components.get('fire-analytics-version')).to.exist;
+      expect(_components.size).to.equal(initialSize + 1);
 
       expect(warnStub.called).to.be.false;
     });
 
     it('will register an arbitrary version component without warnings', () => {
       const warnStub = stub(console, 'warn');
-      const initialSize = components.size;
+      const initialSize = _components.size;
 
       registerVersion('angularfire', '1.2.3');
-      expect(components.get('angularfire-version')).to.exist;
-      expect(components.size).to.equal(initialSize + 1);
+      expect(_components.get('angularfire-version')).to.exist;
+      expect(_components.size).to.equal(initialSize + 1);
 
       expect(warnStub.called).to.be.false;
     });
 
     it('will do nothing if registerVersion() is given illegal characters', () => {
       const warnStub = stub(console, 'warn');
-      const initialSize = components.size;
+      const initialSize = _components.size;
 
       registerVersion('remote config', '1.2.3');
       expect(warnStub.args[0][1]).to.include('library name "remote config"');
-      expect(components.size).to.equal(initialSize);
+      expect(_components.size).to.equal(initialSize);
 
       registerVersion('remote-config', '1.2/3');
       expect(warnStub.args[1][1]).to.include('version name "1.2/3"');
-      expect(components.size).to.equal(initialSize);
+      expect(_components.size).to.equal(initialSize);
     });
   });
 
   describe('User Log Methods', () => {
     describe('Integration Tests', () => {
       beforeEach(() => {
-        clearComponents();
+        _clearComponents();
       });
 
       it(`respects log level set through setLogLevel()`, () => {
         const warnSpy = spy(console, 'warn');
         const infoSpy = spy(console, 'info');
         const logSpy = spy(console, 'log');
         const app = initializeApp({});
-        registerComponent(
+        _registerComponent(
           new Component(
             'test-shell',
             () => {
@@ -252,15 +254,15 @@ describe('API tests', () => {
           )
         );
 
-        getProvider(app, 'test-shell').getImmediate();
+        _getProvider(app, 'test-shell').getImmediate();
       });
 
       it(`correctly triggers callback given to onLog()`, () => {
         const infoSpy = spy(console, 'info');
         let result: any = null;
         // Note: default log level is INFO.
         const app = initializeApp({});
-        registerComponent(
+        _registerComponent(
           new Component(
             'test-shell',
             () => {
@@ -279,7 +281,7 @@ describe('API tests', () => {
             ComponentType.PUBLIC
           )
         );
-        getProvider(app, 'test-shell').getImmediate();
+        _getProvider(app, 'test-shell').getImmediate();
       });
     });
   });