Skip to content

Commit 231f16e

Browse files
tonybaroneeetonybaroneee
committed
Add ref doc generation to telemetry package
1 parent 57c7798 commit 231f16e

File tree

6 files changed

+50
-15
lines changed

6 files changed

+50
-15
lines changed

‎common/api-review/auth.api.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,14 @@ export class AuthCredential {
106106
protected constructor(
107107
providerId: string,
108108
signInMethod: string);
109-
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.d.ts
110-
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.d.ts
109+
// Warning: (ae-forgotten-export) The symbol "AuthInternal" needs to be exported by the entry point index.doc.d.ts
110+
// Warning: (ae-forgotten-export) The symbol "PhoneOrOauthTokenResponse" needs to be exported by the entry point index.doc.d.ts
111111
//
112112
// @internal (undocumented)
113113
_getIdTokenResponse(_auth: AuthInternal): Promise<PhoneOrOauthTokenResponse>;
114114
// @internal (undocumented)
115115
_getReauthenticationResolver(_auth: AuthInternal): Promise<IdTokenResponse>;
116-
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.d.ts
116+
// Warning: (ae-forgotten-export) The symbol "IdTokenResponse" needs to be exported by the entry point index.doc.d.ts
117117
//
118118
// @internal (undocumented)
119119
_linkToIdToken(_auth: AuthInternal, _idToken: string): Promise<IdTokenResponse>;
@@ -299,6 +299,9 @@ export function connectAuthEmulator(auth: Auth, url: string, options?: {
299299
disableWarnings: boolean;
300300
}): void;
301301

302+
// @public
303+
export const cordovaPopupRedirectResolver: PopupRedirectResolver;
304+
302305
// @public
303306
export function createUserWithEmailAndPassword(auth: Auth, email: string, password: string): Promise<UserCredential>;
304307

@@ -362,7 +365,7 @@ export interface EmulatorConfig {
362365

363366
export { ErrorFn }
364367

365-
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.d.ts
368+
// Warning: (ae-forgotten-export) The symbol "BaseOAuthProvider" needs to be exported by the entry point index.doc.d.ts
366369
//
367370
// @public
368371
export class FacebookAuthProvider extends BaseOAuthProvider {
@@ -398,6 +401,9 @@ export function getIdTokenResult(user: User, forceRefresh?: boolean): Promise<Id
398401
// @public
399402
export function getMultiFactorResolver(auth: Auth, error: MultiFactorError): MultiFactorResolver;
400403

404+
// @public
405+
export function getReactNativePersistence(storage: ReactNativeAsyncStorage): Persistence;
406+
401407
// @public
402408
export function getRedirectResult(auth: Auth, resolver?: PopupRedirectResolver): Promise<UserCredential | null>;
403409

@@ -510,7 +516,7 @@ export type NextOrObserver<T> = NextFn<T | null> | Observer<T | null>;
510516
export class OAuthCredential extends AuthCredential {
511517
accessToken?: string;
512518
static fromJSON(json: string | object): OAuthCredential | null;
513-
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.d.ts
519+
// Warning: (ae-forgotten-export) The symbol "OAuthCredentialParams" needs to be exported by the entry point index.doc.d.ts
514520
//
515521
// @internal (undocumented)
516522
static _fromParams(params: OAuthCredentialParams): OAuthCredential;
@@ -615,7 +621,7 @@ export class PhoneAuthCredential extends AuthCredential {
615621
_getReauthenticationResolver(auth: AuthInternal): Promise<IdTokenResponse>;
616622
// @internal (undocumented)
617623
_linkToIdToken(auth: AuthInternal, idToken: string): Promise<IdTokenResponse>;
618-
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.d.ts
624+
// Warning: (ae-forgotten-export) The symbol "SignInWithPhoneNumberRequest" needs to be exported by the entry point index.doc.d.ts
619625
//
620626
// @internal (undocumented)
621627
_makeVerificationRequest(): SignInWithPhoneNumberRequest;
@@ -712,13 +718,13 @@ export interface RecaptchaParameters {
712718
[key: string]: any;
713719
}
714720

715-
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.d.ts
721+
// Warning: (ae-forgotten-export) The symbol "ApplicationVerifierInternal" needs to be exported by the entry point index.doc.d.ts
716722
//
717723
// @public
718724
export class RecaptchaVerifier implements ApplicationVerifierInternal {
719725
constructor(authExtern: Auth, containerOrId: HTMLElement | string, parameters?: RecaptchaParameters);
720726
clear(): void;
721-
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.d.ts
727+
// Warning: (ae-forgotten-export) The symbol "ReCaptchaLoader" needs to be exported by the entry point index.doc.d.ts
722728
//
723729
// @internal (undocumented)
724730
readonly _recaptchaLoader: ReCaptchaLoader;
@@ -735,7 +741,7 @@ export function reload(user: User): Promise<void>;
735741
// @public
736742
export function revokeAccessToken(auth: Auth, token: string): Promise<void>;
737743

738-
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.d.ts
744+
// Warning: (ae-forgotten-export) The symbol "FederatedAuthProvider" needs to be exported by the entry point index.doc.d.ts
739745
//
740746
// @public
741747
export class SAMLAuthProvider extends FederatedAuthProvider {
@@ -816,13 +822,13 @@ export class TotpSecret {
816822
readonly codeIntervalSeconds: number;
817823
readonly codeLength: number;
818824
readonly enrollmentCompletionDeadline: string;
819-
// Warning: (ae-forgotten-export) The symbol "StartTotpMfaEnrollmentResponse" needs to be exported by the entry point index.d.ts
825+
// Warning: (ae-forgotten-export) The symbol "StartTotpMfaEnrollmentResponse" needs to be exported by the entry point index.doc.d.ts
820826
//
821827
// @internal (undocumented)
822828
static _fromStartTotpMfaEnrollmentResponse(response: StartTotpMfaEnrollmentResponse, auth: AuthInternal): TotpSecret;
823829
generateQrCodeUrl(accountName?: string, issuer?: string): string;
824830
readonly hashingAlgorithm: string;
825-
// Warning: (ae-forgotten-export) The symbol "TotpVerificationInfo" needs to be exported by the entry point index.d.ts
831+
// Warning: (ae-forgotten-export) The symbol "TotpVerificationInfo" needs to be exported by the entry point index.doc.d.ts
826832
//
827833
// @internal (undocumented)
828834
_makeTotpVerificationInfo(otp: string): TotpVerificationInfo;

‎common/api-review/telemetry.api.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## API Report File for "@firebase/telemetry"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
// @public
8+
export function testFxn(): number;
9+
10+
// @public (undocumented)
11+
export function tonyFn(): void;
12+
13+
14+
// (No @packageDocumentation comment for this package)
15+
16+
```

‎packages/auth/api-extractor.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"extends": "../../config/api-extractor.json",
3-
"mainEntryPointFilePath": "<projectFolder>/dist/esm/index.d.ts",
3+
"mainEntryPointFilePath": "<projectFolder>/dist/esm/index.doc.d.ts",
44
"dtsRollup": {
55
"enabled": true,
66
"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",

‎packages/telemetry/api-extractor.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"extends": "../../config/api-extractor.json",
3+
// Point it to your entry point d.ts file.
4+
"mainEntryPointFilePath": "<projectFolder>/dist/src/index.d.ts",
5+
"dtsRollup": {
6+
"enabled": true,
7+
"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
8+
"betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
9+
}
10+
}

‎packages/telemetry/package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@
3535
"test:all": "run-p --npm-path npm test:browser test:node",
3636
"test:browser": "karma start",
3737
"test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha src/**/*.test.* --config ../../config/mocharc.node.js",
38-
"trusted-type-check": "tsec -p tsconfig.json --noEmit"
38+
"api-report": "api-extractor run --local --verbose",
39+
"trusted-type-check": "tsec -p tsconfig.json --noEmit",
40+
"typings:public": "node ../../scripts/build/use_typings.js ./dist/telemetry-public.d.ts"
3941
},
4042
"peerDependencies": {
4143
"@firebase/app": "0.x",
@@ -62,7 +64,7 @@
6264
"bugs": {
6365
"url": "https://github.com/firebase/firebase-js-sdk/issues"
6466
},
65-
"typings": "dist/index.d.ts",
67+
"typings": "./dist/telemetry-public.d.ts",
6668
"nyc": {
6769
"extension": [
6870
".ts"

‎scripts/docgen/docgen.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,8 @@ const PREFERRED_PARAMS = [
6060
'performance',
6161
'remoteConfig',
6262
'storage',
63-
'ai'
63+
'ai',
64+
'telemetry'
6465
];
6566

6667
let authApiReportOriginal: string;

0 commit comments

Comments
 (0)