Skip to content

Remove @firebase/app-types-exp #4461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Feb 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"firebase-firestore-integration-test",
"firebase-messaging-integration-test",
"@firebase/app-exp",
"@firebase/app-types-exp",
"@firebase/analytics-exp",
"@firebase/analytics-types-exp",
"@firebase/auth-exp",
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/analytics-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { ControlParams } from '@firebase/analytics-types-exp';
import { CustomParams } from '@firebase/analytics-types-exp';
import { EventNameString } from '@firebase/analytics-types-exp';
import { EventParams } from '@firebase/analytics-types-exp';
import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { Item } from '@firebase/analytics-types-exp';
import { Promotion } from '@firebase/analytics-types-exp';
import { SettingsOptions } from '@firebase/analytics-types-exp';
Expand Down
54 changes: 48 additions & 6 deletions common/api-review/app-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
```ts

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 { ComponentContainer } from '@firebase/component';
import { LogCallback } from '@firebase/logger';
import { LogLevelString } from '@firebase/logger';
import { LogOptions } from '@firebase/logger';
Expand Down Expand Up @@ -35,11 +33,55 @@ export const _DEFAULT_ENTRY_NAME = "[DEFAULT]";
// @public
export function deleteApp(app: FirebaseApp): Promise<void>;

export { FirebaseApp }
// @public
export interface FirebaseApp {
automaticDataCollectionEnabled: boolean;
readonly name: string;
readonly options: FirebaseOptions;
}

// @public
export interface FirebaseAppConfig {
automaticDataCollectionEnabled?: boolean;
name?: string;
}

export { FirebaseAppConfig }
// @internal (undocumented)
export interface _FirebaseAppInternal extends FirebaseApp {
// (undocumented)
checkDestroyed(): void;
// (undocumented)
container: ComponentContainer;
// (undocumented)
isDeleted: boolean;
}

export { FirebaseOptions }
// @public
export interface FirebaseOptions {
// (undocumented)
apiKey?: string;
// (undocumented)
appId?: string;
// (undocumented)
authDomain?: string;
// (undocumented)
databaseURL?: string;
// (undocumented)
measurementId?: string;
// (undocumented)
messagingSenderId?: string;
// (undocumented)
projectId?: string;
// (undocumented)
storageBucket?: string;
}

// @internal (undocumented)
export interface _FirebaseService {
// (undocumented)
app: FirebaseApp;
_delete(): Promise<void>;
}

// @public
export function getApp(name?: string): FirebaseApp;
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/auth-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { ErrorFactory } from '@firebase/util';
import { ErrorFn } from '@firebase/util';
import * as externs from '@firebase/auth-types-exp';
import { FactorId } from '@firebase/auth-types-exp';
import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { FirebaseError } from '@firebase/util';
import { IdTokenResult } from '@firebase/auth-types-exp';
import { MultiFactorAssertion } from '@firebase/auth-types-exp';
Expand Down
2 changes: 1 addition & 1 deletion common/api-review/functions-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```ts

import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { Functions } from '@firebase/functions-types-exp';
import { FunctionsError } from '@firebase/functions-types-exp';
import { FunctionsErrorCode } from '@firebase/functions-types-exp';
Expand Down
4 changes: 3 additions & 1 deletion common/api-review/installations-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@

```ts

import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { FirebaseInstallations } from '@firebase/installations-types-exp';

// @public
export function deleteInstallations(installations: FirebaseInstallations): Promise<void>;

export { FirebaseInstallations }

// @public
export function getId(installations: FirebaseInstallations): Promise<string>;

Expand Down
6 changes: 5 additions & 1 deletion common/api-review/messaging-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```ts

import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { FirebaseMessaging } from '@firebase/messaging-types-exp';
import { MessagePayload } from '@firebase/messaging-types-exp';
import { NextFn } from '@firebase/util';
Expand All @@ -14,6 +14,8 @@ import { Unsubscribe } from '@firebase/util';
// @public
export function deleteToken(messaging: FirebaseMessaging): Promise<boolean>;

export { FirebaseMessaging }

// @public
export function getMessaging(app: FirebaseApp): FirebaseMessaging;

Expand All @@ -23,6 +25,8 @@ export function getToken(messaging: FirebaseMessaging, options?: {
swReg?: ServiceWorkerRegistration;
}): Promise<string>;

export { MessagePayload }

// @public
export function onMessage(messaging: FirebaseMessaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Expand Down
8 changes: 7 additions & 1 deletion common/api-review/performance-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,20 @@

```ts

import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { FirebasePerformance } from '@firebase/performance-types-exp';
import { PerformanceSettings } from '@firebase/performance-types-exp';
import { PerformanceTrace } from '@firebase/performance-types-exp';

export { FirebasePerformance }

// @public
export function getPerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;

export { PerformanceSettings }

export { PerformanceTrace }

// @public
export function trace(performance: FirebasePerformance, name: string): PerformanceTrace;

Expand Down
18 changes: 12 additions & 6 deletions common/api-review/remote-config-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

```ts

import { FirebaseApp } from '@firebase/app-types-exp';
import { LogLevel } from '@firebase/remote-config-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { RemoteConfig } from '@firebase/remote-config-types-exp';
import { Value } from '@firebase/remote-config-types-exp';
import { LogLevel as RemoteConfigLogLevel } from '@firebase/remote-config-types-exp';
import { Value as ValueType } from '@firebase/remote-config-types-exp';

// @public
export function activate(remoteConfig: RemoteConfig): Promise<boolean>;
Expand All @@ -22,7 +22,7 @@ export function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
export function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;

// @public
export function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
export function getAll(remoteConfig: RemoteConfig): Record<string, ValueType>;

// @public
export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
Expand All @@ -37,10 +37,16 @@ export function getRemoteConfig(app: FirebaseApp): RemoteConfig;
export function getString(remoteConfig: RemoteConfig, key: string): string;

// @public
export function getValue(remoteConfig: RemoteConfig, key: string): Value;
export function getValue(remoteConfig: RemoteConfig, key: string): ValueType;

export { RemoteConfig }

export { RemoteConfigLogLevel }

// @public
export function setLogLevel(remoteConfig: RemoteConfig, logLevel: LogLevel): void;
export function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

export { ValueType }


// (No @packageDocumentation comment for this package)
Expand Down
3 changes: 1 addition & 2 deletions packages-exp/analytics-exp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@
"build:doc": "yarn build && yarn doc"
},
"peerDependencies": {
"@firebase/app-exp": "0.x",
"@firebase/app-types-exp": "0.x"
"@firebase/app-exp": "0.x"
},
"dependencies": {
"@firebase/analytics-types-exp": "0.0.900",
Expand Down
3 changes: 1 addition & 2 deletions packages-exp/analytics-exp/src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@
* limitations under the License.
*/

import { _getProvider } from '@firebase/app-exp';
import { FirebaseApp } from '@firebase/app-types-exp';
import { _getProvider, FirebaseApp } from '@firebase/app-exp';
import {
Analytics,
AnalyticsCallOptions,
Expand Down
8 changes: 4 additions & 4 deletions packages-exp/analytics-exp/src/factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { _FirebaseInstallationsInternal } from '@firebase/installations-types-ex
import { areCookiesEnabled, isBrowserExtension } from '@firebase/util';
import { initializeAnalytics } from './initialize-analytics';
import { logger } from './logger';
import { FirebaseApp, _FirebaseService } from '@firebase/app-types-exp';
import { FirebaseApp, _FirebaseService } from '@firebase/app-exp';

/**
* Analytics Service class.
Expand All @@ -60,9 +60,9 @@ export let initializationPromisesMap: {
* wait on all these to be complete in order to determine if it can selectively
* wait for only certain initialization (FID) promises or if it must wait for all.
*/
let dynamicConfigPromisesList: Array<Promise<
DynamicConfig | MinimalDynamicConfig
>> = [];
let dynamicConfigPromisesList: Array<
Promise<DynamicConfig | MinimalDynamicConfig>
> = [];

/**
* Maps fetched measurementIds to appId. Populated when the app's dynamic config
Expand Down
2 changes: 1 addition & 1 deletion packages-exp/analytics-exp/src/get-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* @fileoverview Most logic is copied from packages/remote-config/src/client/retrying_client.ts
*/

import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import {
DynamicConfig,
ThrottleMetadata,
Expand Down
2 changes: 1 addition & 1 deletion packages-exp/analytics-exp/src/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import {
getFakeApp,
getFakeInstallations
} from '../testing/get-fake-firebase-services';
import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { GtagCommand } from './constants';
import { findGtagScriptOnPage } from './helpers';
import { removeGtagScript } from '../testing/gtag-script-util';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import {
} from '../testing/get-fake-firebase-services';
import { GtagCommand } from './constants';
import { DynamicConfig } from '@firebase/analytics-types-exp';
import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { Deferred } from '@firebase/util';
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';

Expand Down
2 changes: 1 addition & 1 deletion packages-exp/analytics-exp/src/initialize-analytics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { GtagCommand, GA_FID_KEY, ORIGIN_KEY } from './constants';
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
import { fetchDynamicConfigWithRetry } from './get-config';
import { logger } from './logger';
import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import {
isIndexedDBAvailable,
validateIndexedDBOpenable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseApp } from '@firebase/app-exp';
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';

export function getFakeApp(fakeAppParams?: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,12 @@
* limitations under the License.
*/

import { initializeApp, deleteApp } from '@firebase/app-exp';
import { initializeApp, deleteApp, FirebaseApp } from '@firebase/app-exp';
import '@firebase/installations-exp';
import { getAnalytics, logEvent } from '../../src/index';
import '../setup';
import { expect } from 'chai';
import { stub } from 'sinon';
import { FirebaseApp } from '@firebase/app-types-exp';

let config: Record<string, string>;
try {
Expand Down
30 changes: 15 additions & 15 deletions packages-exp/app-compat/src/firebaseApp.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,39 +15,39 @@
* limitations under the License.
*/

import { FirebaseApp, FirebaseOptions } from '@firebase/app-types';
import {
_FirebaseNamespace,
FirebaseService
} from '@firebase/app-types/private';
import { FirebaseApp, FirebaseOptions } from './public-types';
import {
Component,
ComponentContainer,
ComponentType,
Name,
ComponentContainer
Name
} from '@firebase/component';
import { _FirebaseAppInternal } from '@firebase/app-types-exp';
import {
deleteApp,
_addComponent,
_addOrOverwriteComponent,
_DEFAULT_ENTRY_NAME
_DEFAULT_ENTRY_NAME,
_FirebaseAppInternal as _FirebaseAppExp
} from '@firebase/app-exp';
import { _FirebaseService, _FirebaseNamespace } from './types';

/**
* Global context object for a collection of services using
* a shared authentication state.
*/
export class FirebaseAppImpl implements FirebaseApp {
private readonly container: ComponentContainer;
private container: ComponentContainer;

constructor(
private readonly app: _FirebaseAppInternal,
private readonly app: _FirebaseAppExp,
private readonly firebase: _FirebaseNamespace
) {
// add itself to container
// TODO: change the component name to 'app-compat' before the official release
_addComponent(app, new Component('app', () => this, ComponentType.PUBLIC));
_addComponent(
app,
new Component('app-compat', () => this, ComponentType.PUBLIC)
);

this.container = app.container;
}

Expand Down Expand Up @@ -94,13 +94,13 @@ export class FirebaseAppImpl implements FirebaseApp {
_getService(
name: string,
instanceIdentifier: string = _DEFAULT_ENTRY_NAME
): FirebaseService {
): _FirebaseService {
this.app.checkDestroyed();

// getImmediate will always succeed because _getService is only called for registered components.
return (this.app.container.getProvider(name as Name).getImmediate({
identifier: instanceIdentifier
}) as unknown) as FirebaseService;
}) as unknown) as _FirebaseService;
}

/**
Expand Down
Loading