Create @firebase/app-compat and firebase/compat

.changeset/config.json

@@ -16,6 +16,7 @@
     "@firebase/functions-types-exp",
     "@firebase/testing",
     "firebase-exp",
+    "@firebase/app-compat",
     "@firebase/changelog-generator",
     "firebase-size-analysis"
   ],

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

@@ -9,7 +9,7 @@ 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 { LogLevelString } from '@firebase/logger';
 import { LogOptions } from '@firebase/logger';
 import { Name } from '@firebase/component';
 import { Provider } from '@firebase/component';
@@ -29,6 +29,9 @@ export function _clearComponents(): void;
 // @internal
 export const _components: Map<string, Component<any>>;
 
+// @internal
+export const _DEFAULT_ENTRY_NAME = "[DEFAULT]";
+
 // @public
 export function deleteApp(app: FirebaseApp): Promise<void>;
 
@@ -47,8 +50,6 @@ export function initializeApp(options: FirebaseOptions, name?: string): Firebase
 // @public
 export function initializeApp(options: FirebaseOptions, config?: FirebaseAppConfig): FirebaseApp;
 
-export { LogLevel }
-
 // @public
 export function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
 
@@ -65,7 +66,7 @@ export function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T
 export const SDK_VERSION: string;
 
 // @public
-export function setLogLevel(logLevel: LogLevel): void;
+export function setLogLevel(logLevel: LogLevelString): void;
 
 
 ```

package.json

@@ -23,9 +23,9 @@
   "scripts": {
     "dev": "lerna run --parallel --scope @firebase/* --scope firebase --scope rxfire dev",
     "build": "lerna run --scope @firebase/app-exp build:deps && lerna run --scope @firebase/* --scope firebase --scope rxfire --ignore @firebase/app-exp build",
-    "build:exp": "lerna run --scope @firebase/*-exp --scope firebase-exp build",
+    "build:exp": "lerna run --scope @firebase/*-exp --scope @firebase/*-compat --scope firebase-exp build",
     "build:release": "lerna run --scope @firebase/app-exp build:deps && lerna run --scope @firebase/* --scope firebase --scope rxfire --ignore @firebase/*-exp prepare",
-    "build:exp:release": "yarn --cwd packages/app build:deps && lerna run --scope @firebase/*-exp --scope firebase-exp prepare && yarn --cwd packages-exp/app-exp typings:public",
+    "build:exp:release": "yarn --cwd packages/app build:deps && lerna run --scope @firebase/*-exp --scope @firebase/*-compat --scope firebase-exp prepare && yarn --cwd packages-exp/app-exp typings:public",
     "build:changed": "ts-node-script scripts/ci-test/build_changed.ts",
     "link:packages": "lerna exec --scope @firebase/* --scope firebase --scope rxfire -- yarn link",
     "stage:packages": "./scripts/prepublish.sh",

packages-exp/app-compat/.eslintrc.js

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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.
+ */
+
+module.exports = {
+  extends: '../../config/.eslintrc.js',
+  parserOptions: {
+    project: 'tsconfig.json',
+    // to make vscode-eslint work with monorepo
+    // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250
+    tsconfigRootDir: __dirname
+  }
+};

packages-exp/app-compat/README.md

@@ -0,0 +1,5 @@
+# @firebase/app-compat
+
+This is the compat package that recreates the v7 APIs.
+
+**This package is not intended for direct usage, and should only be used via the officially supported [firebase](https://www.npmjs.com/package/firebase) package.**

packages-exp/app-compat/karma.conf.js

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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.
+ */
+
+const karmaBase = require('../../config/karma.base');
+
+const files = ['test/**/*', 'src/**/*.test.ts'];
+
+module.exports = function (config) {
+  const karmaConfig = Object.assign({}, karmaBase, {
+    // files to load into karma
+    files: files,
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    preprocessors: { '**/*.ts': ['webpack', 'sourcemap'] },
+    frameworks: ['mocha']
+  });
+
+  config.set(karmaConfig);
+};
+
+module.exports.files = files;

packages-exp/app-compat/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@firebase/app-compat",
+  "version": "0.0.800",
+  "description": "The primary entrypoint to the Firebase JS SDK",
+  "author": "Firebase <[email protected]> (https://firebase.google.com/)",
+  "private": true,
+  "main": "dist/index.cjs.js",
+  "browser": "dist/index.esm5.js",
+  "module": "dist/index.esm5.js",
+  "esm2017": "dist/index.esm2017.js",
+  "lite": "dist/index.lite.js",
+  "lite-esm2017": "dist/index.lite.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:deps": "lerna run --scope @firebase/app-compat --include-dependencies build",
+    "dev": "rollup -c -w",
+    "test": "yarn type-check && run-p lint test:browser test:node",
+    "type-check": "tsc -p . --noEmit",
+    "test:browser": "karma start --single-run",
+    "test:browser:debug": "karma start --browsers Chrome --auto-watch",
+    "test:node": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha test/**/*.test.* src/**/*.test.ts --config ../../config/mocharc.node.js",
+    "prepare": "yarn build"
+  },
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@firebase/app-exp": "0.0.800",
+    "@firebase/util": "0.3.1",
+    "@firebase/logger": "0.2.6",
+    "@firebase/component": "0.1.18",
+    "tslib": "^1.11.1",
+    "dom-storage": "2.1.0",
+    "xmlhttprequest": "1.8.0"
+  },
+  "devDependencies": {
+    "rollup": "2.26.5",
+    "rollup-plugin-json": "4.0.0",
+    "rollup-plugin-replace": "2.2.0",
+    "rollup-plugin-typescript2": "0.27.2",
+    "typescript": "4.0.2"
+  },
+  "repository": {
+    "directory": "packages-exp/app-compat",
+    "type": "git",
+    "url": "https://github.com/firebase/firebase-js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/firebase/firebase-js-sdk/issues"
+  },
+  "typings": "dist/src/index.d.ts",
+  "nyc": {
+    "extension": [
+      ".ts"
+    ],
+    "reportDir": "./coverage/node"
+  }
+}

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

@@ -0,0 +1,102 @@
+/**
+ * @license
+ * Copyright 2018 Google LLC
+ *
+ * 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 typescriptPlugin from 'rollup-plugin-typescript2';
+import json from 'rollup-plugin-json';
+import typescript from 'typescript';
+import pkg from './package.json';
+
+const deps = Object.keys(
+  Object.assign({}, pkg.peerDependencies, pkg.dependencies)
+);
+
+/**
+ * ES5 Builds
+ */
+const es5BuildPlugins = [
+  typescriptPlugin({
+    typescript
+  }),
+  json()
+];
+
+const es5Builds = [
+  {
+    input: 'src/index.ts',
+    output: [
+      { file: pkg.main, format: 'cjs', sourcemap: true },
+      { file: pkg.module, format: 'es', sourcemap: true }
+    ],
+    plugins: es5BuildPlugins,
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  },
+  {
+    input: 'src/index.lite.ts',
+    output: {
+      file: pkg.lite,
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: es5BuildPlugins,
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  }
+];
+
+/**
+ * ES2017 Builds
+ */
+const es2017BuildPlugins = [
+  typescriptPlugin({
+    typescript,
+    tsconfigOverride: {
+      compilerOptions: {
+        target: 'es2017'
+      }
+    }
+  }),
+  json({
+    preferConst: true
+  })
+];
+
+const es2017Builds = [
+  /**
+   *  Browser Builds
+   */
+  {
+    input: 'src/index.ts',
+    output: {
+      file: pkg.esm2017,
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: es2017BuildPlugins,
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  },
+  {
+    input: 'src/index.lite.ts',
+    output: {
+      file: pkg['lite-esm2017'],
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: es2017BuildPlugins,
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  }
+];
+
+export default [...es5Builds, ...es2017Builds];

packages-exp/app-compat/src/errors.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * 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 { ErrorFactory, ErrorMap } from '@firebase/util';
+
+export const enum AppError {
+  NO_APP = 'no-app',
+  INVALID_APP_ARGUMENT = 'invalid-app-argument'
+}
+
+const ERRORS: ErrorMap<AppError> = {
+  [AppError.NO_APP]:
+    "No Firebase App '{$appName}' has been created - " +
+    'call Firebase App.initializeApp()',
+  [AppError.INVALID_APP_ARGUMENT]:
+    'firebase.{$appName}() takes either no argument or a ' +
+    'Firebase App instance.'
+};
+
+type ErrorParams = { [key in AppError]: { appName: string } };
+
+export const ERROR_FACTORY = new ErrorFactory<AppError, ErrorParams>(
+  'app-compat',
+  'Firebase',
+  ERRORS
+);