Skip to content

Commit 04e5322

Browse files
authored
Remove installations-types-exp (#4497)
* remove installations-types-exp * fix installation compat * fix import paths * fix lint error * remove api report * remove unused scripts
1 parent 5e7c013 commit 04e5322

33 files changed

+43
-104
lines changed

.changeset/config.json

-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
"@firebase/functions-compat",
2222
"@firebase/functions-exp",
2323
"@firebase/installations-exp",
24-
"@firebase/installations-types-exp",
2524
"@firebase/installations-compat",
2625
"@firebase/messaging-exp",
2726
"@firebase/performance-exp",

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

+9-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,19 @@
55
```ts
66

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

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

13-
export { FirebaseInstallations }
12+
// @public
13+
export interface FirebaseInstallations {
14+
}
15+
16+
// @internal
17+
export interface _FirebaseInstallationsInternal {
18+
getId(): Promise<string>;
19+
getToken(forceRefresh?: boolean): Promise<string>;
20+
}
1421

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

common/api-review/installations-types-exp.api.md

-20
This file was deleted.

packages-exp/analytics-exp/src/factory.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { SettingsOptions, Analytics } from './public-types';
1919
import { Gtag, DynamicConfig, MinimalDynamicConfig } from './types';
2020
import { getOrCreateDataLayer, wrapOrCreateGtag } from './helpers';
2121
import { AnalyticsError, ERROR_FACTORY } from './errors';
22-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
22+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2323
import { areCookiesEnabled, isBrowserExtension } from '@firebase/util';
2424
import { initializeAnalytics } from './initialize-analytics';
2525
import { logger } from './logger';

packages-exp/analytics-exp/src/index.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import {
3636
resetGlobalVars,
3737
factory as analyticsFactory
3838
} from './factory';
39-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
39+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
4040

4141
let analyticsInstance: AnalyticsService = {} as AnalyticsService;
4242
const fakeMeasurementId = 'abcd-efgh';

packages-exp/analytics-exp/src/initialize-analytics.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { GtagCommand } from './constants';
2727
import { DynamicConfig } from './types';
2828
import { FirebaseApp } from '@firebase/app-exp';
2929
import { Deferred } from '@firebase/util';
30-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
30+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
3131
import { removeGtagScript } from '../testing/gtag-script-util';
3232

3333
const fakeMeasurementId = 'abcd-efgh-ijkl';

packages-exp/analytics-exp/src/initialize-analytics.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import { DynamicConfig, Gtag, MinimalDynamicConfig } from './types';
1919
import { GtagCommand, GA_FID_KEY, ORIGIN_KEY } from './constants';
20-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
20+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2121
import { fetchDynamicConfigWithRetry } from './get-config';
2222
import { logger } from './logger';
2323
import { FirebaseApp } from '@firebase/app-exp';

packages-exp/analytics-exp/testing/get-fake-firebase-services.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
*/
1717

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

2121
export function getFakeApp(fakeAppParams?: {
2222
appId?: string;

packages-exp/installations-compat/package.json

+1-6
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,7 @@
2626
"type-check": "tsc -p . --noEmit",
2727
"serve": "yarn serve:build && yarn serve:host",
2828
"serve:build": "rollup -c test-app/rollup.config.js",
29-
"serve:host": "http-server -c-1 test-app",
30-
"api-report": "api-extractor run --local --verbose",
31-
"predoc": "node ../../scripts/exp/remove-exp.js temp",
32-
"doc": "api-documenter markdown --input temp --output docs",
33-
"build:doc": "yarn build && yarn doc"
29+
"serve:host": "http-server -c-1 test-app"
3430
},
3531
"repository": {
3632
"directory": "packages-exp/installations-compat",
@@ -55,7 +51,6 @@
5551
},
5652
"dependencies": {
5753
"@firebase/installations-exp": "0.0.900",
58-
"@firebase/installations-types-exp": "0.0.900",
5954
"@firebase/util": "0.3.4",
6055
"@firebase/component": "0.2.0",
6156
"idb": "3.0.2",

packages-exp/installations-compat/src/installationsCompat.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
* limitations under the License.
1616
*/
1717

18-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
1918
import { FirebaseInstallations as FirebaseInstallationsCompat } from '@firebase/installations-types';
2019
import { FirebaseApp, _FirebaseService } from '@firebase/app-compat';
2120
import {
21+
FirebaseInstallations,
2222
deleteInstallations,
2323
getId,
2424
getToken,

packages-exp/installations-compat/src/testing/util.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
*/
1717

1818
import { FirebaseApp } from '@firebase/app-compat';
19-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
19+
import { FirebaseInstallations } from '@firebase/installations-exp';
2020

2121
const appName = 'testApp';
2222
const apiKey = 'AIzaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaA';

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

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
// Point it to your entry point d.ts file.
44
"mainEntryPointFilePath": "<projectFolder>/dist/src/index.d.ts",
55
"dtsRollup": {
6-
"enabled": true
6+
"enabled": true,
7+
"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
8+
"publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
79
}
810
}

packages-exp/installations-exp/package.json

+5-4
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"module": "dist/index.esm.js",
88
"browser": "dist/index.esm.js",
99
"esm2017": "dist/index.esm2017.js",
10-
"typings": "dist/installations-exp.d.ts",
10+
"typings": "dist/src/index.d.ts",
1111
"license": "Apache-2.0",
1212
"files": [
1313
"dist"
@@ -17,7 +17,7 @@
1717
"lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
1818
"build": "rollup -c && yarn api-report",
1919
"build:deps": "lerna run --scope @firebase/installations-exp --include-dependencies build",
20-
"build:release": "rollup -c rollup.config.release.js && yarn api-report",
20+
"build:release": "rollup -c rollup.config.release.js && yarn api-report && yarn typings:public",
2121
"dev": "rollup -c -w",
2222
"test": "yarn type-check && yarn test:karma && yarn lint",
2323
"test:ci": "node ../../scripts/run_tests_in_ci.js",
@@ -30,7 +30,9 @@
3030
"api-report": "api-extractor run --local --verbose",
3131
"predoc": "node ../../scripts/exp/remove-exp.js temp",
3232
"doc": "api-documenter markdown --input temp --output docs",
33-
"build:doc": "yarn build && yarn doc"
33+
"build:doc": "yarn build && yarn doc",
34+
"typings:public": "node ../../scripts/exp/use_typings.js ./dist/installations-exp-public.d.ts",
35+
"typings:internal": "node ../../scripts/exp/use_typings.js ./dist/src/index.d.ts"
3436
},
3537
"repository": {
3638
"directory": "packages-exp/installations-exp",
@@ -54,7 +56,6 @@
5456
"@firebase/app-exp": "0.x"
5557
},
5658
"dependencies": {
57-
"@firebase/installations-types-exp": "0.0.900",
5859
"@firebase/util": "0.3.4",
5960
"@firebase/component": "0.2.0",
6061
"idb": "3.0.2",

packages-exp/installations-exp/src/api/delete-installations.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { remove, update } from '../helpers/idb-manager';
2020
import { RequestStatus } from '../interfaces/installation-entry';
2121
import { ERROR_FACTORY, ErrorCode } from '../util/errors';
2222
import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
23-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
23+
import { FirebaseInstallations } from '../interfaces/public-types';
2424

2525
/**
2626
* Deletes the Firebase Installation and all associated data.
@@ -54,5 +54,3 @@ export async function deleteInstallations(
5454
}
5555
}
5656
}
57-
58-
export { FirebaseInstallations };

packages-exp/installations-exp/src/api/get-id.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import { getInstallationEntry } from '../helpers/get-installation-entry';
1919
import { refreshAuthToken } from '../helpers/refresh-auth-token';
2020
import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
21-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
21+
import { FirebaseInstallations } from '../interfaces/public-types';
2222

2323
/**
2424
* Creates a Firebase Installation if there isn't one for the app and

packages-exp/installations-exp/src/api/get-installations.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
*/
1717

1818
import { FirebaseApp, _getProvider } from '@firebase/app-exp';
19-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
19+
import { FirebaseInstallations } from '../interfaces/public-types';
2020

2121
/**
2222
* Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance.

packages-exp/installations-exp/src/api/get-token.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
FirebaseInstallationsImpl,
2222
AppConfig
2323
} from '../interfaces/installation-impl';
24-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
24+
import { FirebaseInstallations } from '../interfaces/public-types';
2525

2626
/**
2727
* Returns an Installation auth token, identifying the current Firebase Installation.

packages-exp/installations-exp/src/api/on-id-change.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import { addCallback, removeCallback } from '../helpers/fid-changed';
1919
import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
20-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
20+
import { FirebaseInstallations } from '../interfaces/public-types';
2121

2222
/**
2323
* An user defined callback function that gets called when Installations ID changes.

packages-exp/installations-exp/src/functions/config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323
ComponentContainer
2424
} from '@firebase/component';
2525
import { getId, getToken } from '../api/index';
26-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
26+
import { _FirebaseInstallationsInternal } from '../interfaces/public-types';
2727
import { FirebaseInstallationsImpl } from '../interfaces/installation-impl';
2828
import { extractAppConfig } from '../helpers/extract-app-config';
2929

packages-exp/installations-exp/src/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import { registerVersion } from '@firebase/app-exp';
2020
import { name, version } from '../package.json';
2121

2222
export * from './api';
23+
export * from './interfaces/public-types';
2324

2425
registerInstallations();
2526
registerVersion(name, version);

packages-exp/installations-exp/src/interfaces/installation-impl.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import { Provider } from '@firebase/component';
1919
import { _FirebaseService } from '@firebase/app-exp';
20-
import { FirebaseInstallations } from '@firebase/installations-types-exp';
20+
import { FirebaseInstallations } from '../interfaces/public-types';
2121

2222
export interface FirebaseInstallationsImpl
2323
extends FirebaseInstallations,

packages-exp/installations-types-exp/index.d.ts renamed to packages-exp/installations-exp/src/interfaces/public-types.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* @license
3-
* Copyright 2019 Google LLC
3+
* Copyright 2020 Google LLC
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");
66
* you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@ export interface FirebaseInstallations {}
2727
*
2828
* @internal
2929
*/
30+
// eslint-disable-next-line @typescript-eslint/naming-convention
3031
export interface _FirebaseInstallationsInternal {
3132
/**
3233
* Creates a Firebase Installation if there isn't one for the app and

packages-exp/installations-types-exp/api-extractor.json

-5
This file was deleted.

packages-exp/installations-types-exp/package.json

-33
This file was deleted.

packages-exp/installations-types-exp/tsconfig.json

-7
This file was deleted.

packages-exp/messaging-exp/src/interfaces/internal-dependencies.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { AppConfig } from './app-config';
1919
import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types';
2020
import { FirebaseApp } from '@firebase/app-exp';
2121
import { Provider } from '@firebase/component';
22-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
22+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2323

2424
export interface FirebaseInternalDependencies {
2525
app: FirebaseApp;

packages-exp/messaging-exp/src/messaging-service.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { FirebaseAnalyticsInternalName } from '@firebase/analytics-interop-types
2222
import { FirebaseInternalDependencies } from './interfaces/internal-dependencies';
2323
import { MessagePayload } from './interfaces/public-types';
2424
import { Provider } from '@firebase/component';
25-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
25+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2626
import { extractAppConfig } from './helpers/extract-app-config';
2727

2828
export class MessagingService implements _FirebaseService {

packages-exp/messaging-exp/src/testing/fakes/firebase-dependencies.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323
import { FirebaseInternalDependencies } from '../../interfaces/internal-dependencies';
2424
import { FirebaseOptions } from '@firebase/app-exp';
2525
import { Provider } from '@firebase/component';
26-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
26+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2727
import { extractAppConfig } from '../../helpers/extract-app-config';
2828

2929
export function getFakeFirebaseDependencies(

packages-exp/performance-exp/src/controllers/perf.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import * as initializationService from '../services/initialization_service';
2323
import { SettingsService } from '../services/settings_service';
2424
import { consoleLogger } from '../utils/console_logger';
2525
import { FirebaseApp } from '@firebase/app-exp';
26-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
26+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2727
import '../../test/setup';
2828

2929
describe('Firebase Performance Test', () => {

packages-exp/performance-exp/src/controllers/perf.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { SettingsService } from '../services/settings_service';
2020
import { getInitializationPromise } from '../services/initialization_service';
2121
import { Api } from '../services/api_service';
2222
import { FirebaseApp } from '@firebase/app-exp';
23-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
23+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2424
import { PerformanceSettings, FirebasePerformance } from '../public_types';
2525
import { validateIndexedDBOpenable } from '@firebase/util';
2626
import { setupTransportService } from '../services/transport_service';

packages-exp/performance-exp/src/services/iid_service.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import {
2424
getAuthTokenPromise
2525
} from './iid_service';
2626
import '../../test/setup';
27-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
27+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2828

2929
describe('Firebase Perofmrance > iid_service', () => {
3030
const IID = 'fid';

packages-exp/performance-exp/src/services/iid_service.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
18+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
1919

2020
let iid: string | undefined;
2121
let authToken: string | undefined;

packages-exp/remote-config-exp/src/client/rest_client.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import {
2323
} from './remote_config_fetch_client';
2424
import { ERROR_FACTORY, ErrorCode } from '../errors';
2525
import { getUserLanguage } from '../language';
26-
import { _FirebaseInstallationsInternal } from '@firebase/installations-types-exp';
26+
import { _FirebaseInstallationsInternal } from '@firebase/installations-exp';
2727

2828
/**
2929
* Defines request body parameters required to call the fetch API:

0 commit comments

Comments
 (0)