Skip to content

Commit 4d279f7

Browse files
maneeshtmaneesht
committed
Added new docs
1 parent f45f6b2 commit 4d279f7

File tree

7 files changed

+102
-8
lines changed

7 files changed

+102
-8
lines changed

‎docs-devsite/_toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,8 @@ toc:
176176
- title: data-connect
177177
path: /docs/reference/js/data-connect.md
178178
section:
179+
- title: AppCheckTokenProvider
180+
path: /docs/reference/js/data-connect.appchecktokenprovider.md
179181
- title: AuthTokenProvider
180182
path: /docs/reference/js/data-connect.authtokenprovider.md
181183
- title: CancellableOperation

‎docs-devsite/data-connect.appchecktokenprovider.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# AppCheckTokenProvider class
13+
Abstraction around AppCheck's token fetching capabilities.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class AppCheckTokenProvider
19+
```
20+
21+
## Constructors
22+
23+
| Constructor | Modifiers | Description |
24+
| --- | --- | --- |
25+
| [(constructor)(appName\_, appCheckProvider)](./data-connect.appchecktokenprovider.md#appchecktokenproviderconstructor) | | Constructs a new instance of the <code>AppCheckTokenProvider</code> class |
26+
27+
## Methods
28+
29+
| Method | Modifiers | Description |
30+
| --- | --- | --- |
31+
| [addTokenChangeListener(listener)](./data-connect.appchecktokenprovider.md#appchecktokenprovideraddtokenchangelistener) | | |
32+
| [getToken(forceRefresh)](./data-connect.appchecktokenprovider.md#appchecktokenprovidergettoken) | | |
33+
34+
## AppCheckTokenProvider.(constructor)
35+
36+
Constructs a new instance of the `AppCheckTokenProvider` class
37+
38+
<b>Signature:</b>
39+
40+
```typescript
41+
constructor(appName_: string, appCheckProvider?: Provider<AppCheckInternalComponentName>);
42+
```
43+
44+
#### Parameters
45+
46+
| Parameter | Type | Description |
47+
| --- | --- | --- |
48+
| appName\_ | string | |
49+
| appCheckProvider | Provider&lt;AppCheckInternalComponentName&gt; | |
50+
51+
## AppCheckTokenProvider.addTokenChangeListener()
52+
53+
<b>Signature:</b>
54+
55+
```typescript
56+
addTokenChangeListener(listener: AppCheckTokenListener): void;
57+
```
58+
59+
#### Parameters
60+
61+
| Parameter | Type | Description |
62+
| --- | --- | --- |
63+
| listener | AppCheckTokenListener | |
64+
65+
<b>Returns:</b>
66+
67+
void
68+
69+
## AppCheckTokenProvider.getToken()
70+
71+
<b>Signature:</b>
72+
73+
```typescript
74+
getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
75+
```
76+
77+
#### Parameters
78+
79+
| Parameter | Type | Description |
80+
| --- | --- | --- |
81+
| forceRefresh | boolean | |
82+
83+
<b>Returns:</b>
84+
85+
Promise&lt;AppCheckTokenResult&gt;
86+

‎docs-devsite/data-connect.dataconnect.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export declare class DataConnect
2222

2323
| Constructor | Modifiers | Description |
2424
| --- | --- | --- |
25-
| [(constructor)(app, dataConnectOptions, \_authProvider)](./data-connect.dataconnect.md#dataconnectconstructor) | | Constructs a new instance of the <code>DataConnect</code> class |
25+
| [(constructor)(app, dataConnectOptions, \_authProvider, \_appCheckProvider)](./data-connect.dataconnect.md#dataconnectconstructor) | | Constructs a new instance of the <code>DataConnect</code> class |
2626

2727
## Properties
2828

@@ -47,7 +47,7 @@ Constructs a new instance of the `DataConnect` class
4747
<b>Signature:</b>
4848

4949
```typescript
50-
constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>);
50+
constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
5151
```
5252

5353
#### Parameters
@@ -57,6 +57,7 @@ constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvi
5757
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | |
5858
| dataConnectOptions | [DataConnectOptions](./data-connect.dataconnectoptions.md#dataconnectoptions_interface) | |
5959
| \_authProvider | Provider&lt;FirebaseAuthInternalName&gt; | |
60+
| \_appCheckProvider | Provider&lt;AppCheckInternalComponentName&gt; | |
6061

6162
## DataConnect.app
6263

‎docs-devsite/data-connect.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Firebase Data Connect
4545

4646
| Class | Description |
4747
| --- | --- |
48+
| [AppCheckTokenProvider](./data-connect.appchecktokenprovider.md#appchecktokenprovider_class) | Abstraction around AppCheck's token fetching capabilities. |
4849
| [DataConnect](./data-connect.dataconnect.md#dataconnect_class) | Class representing Firebase Data Connect |
4950
| [FirebaseAuthProvider](./data-connect.firebaseauthprovider.md#firebaseauthprovider_class) | |
5051

@@ -532,5 +533,5 @@ export declare type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR;
532533
<b>Signature:</b>
533534

534535
```typescript
535-
export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
536+
export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, appCheckProvider?: AppCheckTokenProvider, transportOptions?: TransportOptions, _isUsingGen?: boolean) => DataConnectTransport;
536537
```

‎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/esm5/index.d.ts",
3+
"mainEntryPointFilePath": "<projectFolder>/dist/esm5/index.doc.d.ts",
44
"dtsRollup": {
55
"enabled": true,
66
"untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",

‎packages/data-connect/src/core/AppCheckTokenProvider.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ export class AppCheckTokenProvider {
3434
) {
3535
this.appCheck = appCheckProvider?.getImmediate({ optional: true });
3636
if (!this.appCheck) {
37-
appCheckProvider?.get().then(appCheck => (this.appCheck = appCheck));
37+
appCheckProvider
38+
?.get()
39+
.then(appCheck => (this.appCheck = appCheck))
40+
.catch();
3841
}
3942
}
4043

@@ -57,10 +60,11 @@ export class AppCheckTokenProvider {
5760
return this.appCheck.getToken(forceRefresh);
5861
}
5962

60-
addTokenChangeListener(listener: AppCheckTokenListener) {
63+
addTokenChangeListener(listener: AppCheckTokenListener): void {
6164
this.appCheckProvider
6265
?.get()
63-
.then(appCheck => appCheck.addTokenListener(listener));
66+
.then(appCheck => appCheck.addTokenListener(listener))
67+
.catch();
6468
}
6569

6670
// Not currently used at the moment. Will update if needed.

‎packages/data-connect/test/unit/userAgent.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ describe('User Agent Tests', () => {
4242
let app: FirebaseApp;
4343
beforeEach(() => {
4444
initializeFetch(fakeFetchImpl);
45-
app = initializeApp({projectId: 'p'}, 'abc'); // TODO(mtewani): Replace with util function
45+
app = initializeApp({ projectId: 'p' }, 'abc'); // TODO(mtewani): Replace with util function
4646
dc = getDataConnect(app, { connector: 'c', location: 'l', service: 's' });
4747
});
4848
afterEach(async () => {

0 commit comments

Comments
 (0)