Skip to content

Commit 65fc368

Browse files
authored
Merge f2762ac into 8893c82
2 parents 8893c82 + f2762ac commit 65fc368

File tree

4 files changed

+38
-6
lines changed

4 files changed

+38
-6
lines changed

.changeset/four-taxis-fry.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@firebase/app-check': patch
3+
'@firebase/app-check-types': patch
4+
'firebase': patch
5+
---
6+
7+
Fixed argument typings for `activate()`.

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ export interface FirebaseAppCheck {
3232
* defaults to false and can be set in the app config.
3333
*/
3434
activate(
35-
siteKeyOrProvider: string | AppCheckProvider,
35+
siteKeyOrProvider:
36+
| string
37+
| AppCheckProvider
38+
| CustomProvider
39+
| ReCaptchaV3Provider,
3640
isTokenAutoRefreshEnabled?: boolean
3741
): void;
3842

packages/app-check/src/factory.ts

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818
import {
1919
FirebaseAppCheck,
2020
AppCheckProvider,
21-
AppCheckTokenResult
21+
AppCheckTokenResult,
22+
ReCaptchaV3Provider,
23+
CustomProvider
2224
} from '@firebase/app-check-types';
2325
import {
2426
activate,
@@ -33,6 +35,10 @@ import {
3335
addTokenListener,
3436
removeTokenListener
3537
} from './internal-api';
38+
import {
39+
ReCaptchaV3Provider as ReCaptchaV3ProviderImpl,
40+
CustomProvider as CustomProviderImpl
41+
} from './providers';
3642
import { Provider } from '@firebase/component';
3743
import { PartialObserver } from '@firebase/util';
3844

@@ -46,12 +52,23 @@ export function factory(
4652
return {
4753
app,
4854
activate: (
49-
siteKeyOrProvider: AppCheckProvider | string,
55+
siteKeyOrProvider:
56+
| ReCaptchaV3Provider
57+
| CustomProvider
58+
| AppCheckProvider
59+
| string,
5060
isTokenAutoRefreshEnabled?: boolean
5161
) =>
5262
activate(
5363
app,
54-
siteKeyOrProvider,
64+
// Public types of ReCaptchaV3Provider/CustomProvider don't
65+
// expose getToken() and aren't recognized as the internal
66+
// class version of themselves.
67+
siteKeyOrProvider as
68+
| ReCaptchaV3ProviderImpl
69+
| CustomProviderImpl
70+
| AppCheckProvider
71+
| string,
5572
platformLoggerProvider,
5673
isTokenAutoRefreshEnabled
5774
),

packages/firebase/index.d.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1580,14 +1580,18 @@ declare namespace firebase.appCheck {
15801580
export interface AppCheck {
15811581
/**
15821582
* Activate AppCheck
1583-
* @param provider reCAPTCHA or custom token provider.
1583+
* @param provider reCAPTCHA provider, custom token provider, or reCAPTCHA site key.
15841584
* @param isTokenAutoRefreshEnabled If true, the SDK automatically
15851585
* refreshes App Check tokens as needed. If undefined, defaults to the
15861586
* value of `app.automaticDataCollectionEnabled`, which defaults to
15871587
* false and can be set in the app config.
15881588
*/
15891589
activate(
1590-
provider: AppCheckProvider,
1590+
provider:
1591+
| ReCaptchaV3Provider
1592+
| CustomProvider
1593+
| AppCheckProvider
1594+
| string,
15911595
isTokenAutoRefreshEnabled?: boolean
15921596
): void;
15931597

0 commit comments

Comments
 (0)