Skip to content

Commit a67d320

Browse files
authored
[Exp] Export public types from App, RC, FCM, Perf, and Installations (#4350)
* share use_typings.js * fix bugs * export public types from app-exp * build app-exp release * export types from app, rc and fcm * export types from perf * export types from installations * fix perf type exports
1 parent 9533688 commit a67d320

File tree

15 files changed

+83
-31
lines changed

15 files changed

+83
-31
lines changed

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
```ts
66

77
import { Component } from '@firebase/component';
8-
import { FirebaseApp } from '@firebase/app-types-exp';
9-
import { FirebaseAppConfig } from '@firebase/app-types-exp';
10-
import { FirebaseOptions } from '@firebase/app-types-exp';
8+
import { FirebaseApp } from '@firebase/app-types';
9+
import { FirebaseAppConfig } from '@firebase/app-types';
10+
import { FirebaseOptions } from '@firebase/app-types';
1111
import { LogCallback } from '@firebase/logger';
1212
import { LogLevelString } from '@firebase/logger';
1313
import { LogOptions } from '@firebase/logger';
@@ -35,6 +35,12 @@ export const _DEFAULT_ENTRY_NAME = "[DEFAULT]";
3535
// @public
3636
export function deleteApp(app: FirebaseApp): Promise<void>;
3737

38+
export { FirebaseApp }
39+
40+
export { FirebaseAppConfig }
41+
42+
export { FirebaseOptions }
43+
3844
// @public
3945
export function getApp(name?: string): FirebaseApp;
4046

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ export interface _FirebaseService {
6060
_delete(): Promise<void>;
6161
}
6262

63-
// @public (undocumented)
64-
export interface PlatformLoggerService {
63+
// @internal (undocumented)
64+
export interface _PlatformLoggerService {
6565
// (undocumented)
6666
getPlatformInfoString(): string;
6767
}
6868

69-
// @public (undocumented)
70-
export interface VersionService {
69+
// @internal (undocumented)
70+
export interface _VersionService {
7171
// (undocumented)
7272
library: string;
7373
// (undocumented)

packages-exp/app-exp/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@
2525
"predoc": "node ../../scripts/exp/remove-exp.js temp",
2626
"doc": "api-documenter markdown --input temp --output docs",
2727
"build:doc": "yarn build && yarn doc",
28-
"typings:public": "node ./use_typings.js --public",
29-
"typings:internal": "node ./use_typings.js"
28+
"typings:public": "node ../../scripts/exp/use_typings.js ./dist/app-exp-public.d.ts",
29+
"typings:internal": "node ../../scripts/exp/use_typings.js ./dist/app-exp.d.ts"
3030
},
3131
"dependencies": {
3232
"@firebase/app-types-exp": "0.0.900",

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ const es5BuildPlugins = [
2828
typescriptPlugin({
2929
typescript,
3030
clean: true,
31+
abortOnError: false,
3132
transformers: [importPathTransformer]
3233
}),
3334
json()
@@ -53,6 +54,7 @@ const es2017BuildPlugins = [
5354
}
5455
},
5556
clean: true,
57+
abortOnError: false,
5658
transformers: [importPathTransformer]
5759
}),
5860
json({

packages-exp/app-exp/src/api.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,3 +303,5 @@ export function onLog(
303303
export function setLogLevel(logLevel: LogLevelString): void {
304304
setLogLevelImpl(logLevel);
305305
}
306+
307+
export { FirebaseApp, FirebaseAppConfig, FirebaseOptions };
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{
22
"extends": "../../config/api-extractor.json",
33
// Point it to your entry point d.ts file.
4-
"mainEntryPointFilePath": "<projectFolder>/index.d.ts"
4+
"mainEntryPointFilePath": "<projectFolder>/index.d.ts",
5+
"dtsRollup": {
6+
"enabled": true,
7+
"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
8+
"publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
9+
}
510
}

packages-exp/app-types-exp/index.d.ts

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ export interface FirebaseAppConfig {
9898
}
9999

100100
/**
101-
* @public
101+
* @internal
102102
*/
103-
export interface PlatformLoggerService {
103+
export interface _PlatformLoggerService {
104104
getPlatformInfoString(): string;
105105
}
106106

@@ -116,15 +116,18 @@ export interface _FirebaseService {
116116
_delete(): Promise<void>;
117117
}
118118

119-
export interface VersionService {
119+
/**
120+
* @internal
121+
*/
122+
export interface _VersionService {
120123
library: string;
121124
version: string;
122125
}
123126

124127
declare module '@firebase/component' {
125128
interface NameServiceMapping {
126129
'app-exp': FirebaseApp;
127-
'app-version': VersionService;
128-
'platform-logger': PlatformLoggerService;
130+
'app-version': _VersionService;
131+
'platform-logger': _PlatformLoggerService;
129132
}
130133
}

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@
1111
"api-report": "api-extractor run --local --verbose",
1212
"predoc": "node ../../scripts/exp/remove-exp.js temp",
1313
"doc": "api-documenter markdown --input temp --output docs",
14-
"build:doc": "yarn api-report && yarn doc"
14+
"build:doc": "yarn api-report && yarn doc",
15+
"build:release": "yarn api-report && yarn typings:public",
16+
"typings:public": "node ../../scripts/exp/use_typings.js ./dist/app-types-exp-public.d.ts",
17+
"typings:internal": "node ../../scripts/exp/use_typings.js ./index.d.ts"
1518
},
1619
"files": [
1720
"index.d.ts",

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,5 @@ export async function deleteInstallations(
5454
}
5555
}
5656
}
57+
58+
export { FirebaseInstallations };

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,3 +126,5 @@ export function onBackgroundMessage(
126126
): Unsubscribe {
127127
return _onBackgroundMessage(messaging as MessagingService, nextOrObserver);
128128
}
129+
130+
export { FirebaseMessaging, MessagePayload };

0 commit comments

Comments
 (0)