entropic-bond 1.50.0 → 1.50.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/auth/auth-mock.d.ts +22 -0
- package/lib/auth/auth-mock.spec.d.ts +1 -0
- package/lib/auth/auth.d.ts +131 -0
- package/lib/auth/user-auth-types.d.ts +19 -0
- package/lib/cloud-functions/cloud-functions-mock.d.ts +11 -0
- package/lib/cloud-functions/cloud-functions-mock.spec.d.ts +1 -0
- package/lib/cloud-functions/cloud-functions.d.ts +19 -0
- package/lib/cloud-storage/cloud-storage.d.ts +24 -0
- package/lib/cloud-storage/cloud-storage.spec.d.ts +1 -0
- package/lib/cloud-storage/mock-cloud-storage.d.ts +20 -0
- package/lib/cloud-storage/stored-file.d.ts +39 -0
- package/lib/entropic-bond.js +1667 -0
- package/lib/entropic-bond.umd.cjs +7 -0
- package/lib/index.d.ts +19 -0
- package/lib/observable/observable.d.ts +52 -0
- package/lib/observable/observable.spec.d.ts +1 -0
- package/lib/persistent/entropic-component.d.ts +76 -0
- package/lib/persistent/entropic-component.spec.d.ts +1 -0
- package/lib/persistent/persistent.d.ts +281 -0
- package/lib/persistent/persistent.spec.d.ts +67 -0
- package/lib/server-auth/server-auth-mock.d.ts +12 -0
- package/lib/server-auth/server-auth-mock.spec.d.ts +1 -0
- package/lib/server-auth/server-auth.d.ts +24 -0
- package/lib/store/data-source.d.ts +137 -0
- package/lib/store/json-data-source.d.ts +68 -0
- package/lib/store/json-data-source.spec.d.ts +1 -0
- package/lib/store/mocks/test-user.d.ts +49 -0
- package/lib/store/model.d.ts +238 -0
- package/lib/store/model.spec.d.ts +1 -0
- package/lib/store/store.d.ts +62 -0
- package/lib/store/store.spec.d.ts +1 -0
- package/lib/types/utility-types.d.ts +45 -0
- package/lib/types/utility-types.spec.d.ts +1 -0
- package/lib/utils/test-utils/test-person.d.ts +33 -0
- package/{src/utils/utils.ts → lib/utils/utils.d.ts} +10 -34
- package/lib/utils/utils.spec.d.ts +1 -0
- package/package.json +4 -1
- package/.github/workflows/release.yml +0 -26
- package/CHANGELOG.md +0 -1151
- package/docs/.nojekyll +0 -1
- package/docs/README.md +0 -94
- package/docs/classes/Auth.md +0 -391
- package/docs/classes/AuthMock.md +0 -278
- package/docs/classes/AuthService.md +0 -188
- package/docs/classes/CloudFunctions.md +0 -123
- package/docs/classes/CloudFunctionsMock.md +0 -97
- package/docs/classes/CloudStorage.md +0 -215
- package/docs/classes/DataSource.md +0 -248
- package/docs/classes/EntropicComponent.md +0 -666
- package/docs/classes/JsonDataSource.md +0 -328
- package/docs/classes/MockCloudStorage.md +0 -279
- package/docs/classes/Model.md +0 -274
- package/docs/classes/Observable.md +0 -120
- package/docs/classes/Persistent.md +0 -420
- package/docs/classes/ServerAuth.md +0 -211
- package/docs/classes/ServerAuthMock.md +0 -176
- package/docs/classes/ServerAuthService.md +0 -130
- package/docs/classes/Store.md +0 -218
- package/docs/classes/StoredFile.md +0 -636
- package/docs/enums/StoredFileEvent.md +0 -41
- package/docs/interfaces/AuthError.md +0 -30
- package/docs/interfaces/CloudFunctionsService.md +0 -69
- package/docs/interfaces/Collection.md +0 -13
- package/docs/interfaces/CustomCredentials.md +0 -7
- package/docs/interfaces/DocumentReference.md +0 -49
- package/docs/interfaces/JsonRawData.md +0 -7
- package/docs/interfaces/SignData.md +0 -63
- package/docs/interfaces/StoreParams.md +0 -52
- package/docs/interfaces/StoredFileChange.md +0 -41
- package/docs/interfaces/UploadControl.md +0 -90
- package/docs/interfaces/UserCredentials.md +0 -113
- package/docs/interfaces/Values.md +0 -17
- package/docs/modules.md +0 -1273
- package/src/auth/auth-mock.spec.ts +0 -168
- package/src/auth/auth-mock.ts +0 -129
- package/src/auth/auth.ts +0 -185
- package/src/auth/user-auth-types.ts +0 -21
- package/src/cloud-functions/cloud-functions-mock.spec.ts +0 -136
- package/src/cloud-functions/cloud-functions-mock.ts +0 -23
- package/src/cloud-functions/cloud-functions.ts +0 -83
- package/src/cloud-storage/cloud-storage.spec.ts +0 -207
- package/src/cloud-storage/cloud-storage.ts +0 -60
- package/src/cloud-storage/mock-cloud-storage.ts +0 -72
- package/src/cloud-storage/stored-file.ts +0 -102
- package/src/index.ts +0 -19
- package/src/observable/observable.spec.ts +0 -105
- package/src/observable/observable.ts +0 -67
- package/src/persistent/entropic-component.spec.ts +0 -143
- package/src/persistent/entropic-component.ts +0 -135
- package/src/persistent/persistent.spec.ts +0 -828
- package/src/persistent/persistent.ts +0 -650
- package/src/server-auth/server-auth-mock.spec.ts +0 -53
- package/src/server-auth/server-auth-mock.ts +0 -45
- package/src/server-auth/server-auth.ts +0 -49
- package/src/store/data-source.ts +0 -186
- package/src/store/json-data-source.spec.ts +0 -100
- package/src/store/json-data-source.ts +0 -256
- package/src/store/mocks/mock-data.json +0 -155
- package/src/store/mocks/test-user.ts +0 -122
- package/src/store/model.spec.ts +0 -659
- package/src/store/model.ts +0 -462
- package/src/store/store.spec.ts +0 -30
- package/src/store/store.ts +0 -113
- package/src/types/utility-types.spec.ts +0 -117
- package/src/types/utility-types.ts +0 -116
- package/src/utils/test-utils/test-person.ts +0 -44
- package/src/utils/utils.spec.ts +0 -95
- package/tsconfig-build.json +0 -7
- package/tsconfig-cjs.json +0 -9
- package/tsconfig.json +0 -33
- package/vite.config.ts +0 -22
package/docs/classes/AuthMock.md
DELETED
|
@@ -1,278 +0,0 @@
|
|
|
1
|
-
[entropic-bond](../README.md) / [Exports](../modules.md) / AuthMock
|
|
2
|
-
|
|
3
|
-
# Class: AuthMock
|
|
4
|
-
|
|
5
|
-
The AuthService class is an abstract class that defines the interface of an authentication service.
|
|
6
|
-
You should derive from this class to implement your own authentication service.
|
|
7
|
-
|
|
8
|
-
## Hierarchy
|
|
9
|
-
|
|
10
|
-
- [`AuthService`](AuthService.md)
|
|
11
|
-
|
|
12
|
-
↳ **`AuthMock`**
|
|
13
|
-
|
|
14
|
-
## Table of contents
|
|
15
|
-
|
|
16
|
-
### Constructors
|
|
17
|
-
|
|
18
|
-
- [constructor](AuthMock.md#constructor)
|
|
19
|
-
|
|
20
|
-
### Accessors
|
|
21
|
-
|
|
22
|
-
- [fakeRegisteredUsers](AuthMock.md#fakeregisteredusers)
|
|
23
|
-
|
|
24
|
-
### Methods
|
|
25
|
-
|
|
26
|
-
- [fakeRegisteredUser](AuthMock.md#fakeregistereduser)
|
|
27
|
-
- [flush](AuthMock.md#flush)
|
|
28
|
-
- [linkAdditionalProvider](AuthMock.md#linkadditionalprovider)
|
|
29
|
-
- [login](AuthMock.md#login)
|
|
30
|
-
- [logout](AuthMock.md#logout)
|
|
31
|
-
- [onAuthStateChange](AuthMock.md#onauthstatechange)
|
|
32
|
-
- [resetEmailPassword](AuthMock.md#resetemailpassword)
|
|
33
|
-
- [signUp](AuthMock.md#signup)
|
|
34
|
-
- [unlinkProvider](AuthMock.md#unlinkprovider)
|
|
35
|
-
|
|
36
|
-
## Constructors
|
|
37
|
-
|
|
38
|
-
### constructor
|
|
39
|
-
|
|
40
|
-
• **new AuthMock**()
|
|
41
|
-
|
|
42
|
-
#### Inherited from
|
|
43
|
-
|
|
44
|
-
[AuthService](AuthService.md).[constructor](AuthService.md#constructor)
|
|
45
|
-
|
|
46
|
-
## Accessors
|
|
47
|
-
|
|
48
|
-
### fakeRegisteredUsers
|
|
49
|
-
|
|
50
|
-
• `get` **fakeRegisteredUsers**(): [`Collection`](../interfaces/Collection.md)<[`UserCredentials`](../interfaces/UserCredentials.md)<{}\>\>
|
|
51
|
-
|
|
52
|
-
#### Returns
|
|
53
|
-
|
|
54
|
-
[`Collection`](../interfaces/Collection.md)<[`UserCredentials`](../interfaces/UserCredentials.md)<{}\>\>
|
|
55
|
-
|
|
56
|
-
#### Defined in
|
|
57
|
-
|
|
58
|
-
[auth/auth-mock.ts:85](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L85)
|
|
59
|
-
|
|
60
|
-
## Methods
|
|
61
|
-
|
|
62
|
-
### fakeRegisteredUser
|
|
63
|
-
|
|
64
|
-
▸ **fakeRegisteredUser**<`T`\>(`userCredentials`): [`AuthMock`](AuthMock.md)
|
|
65
|
-
|
|
66
|
-
#### Type parameters
|
|
67
|
-
|
|
68
|
-
| Name | Type |
|
|
69
|
-
| :------ | :------ |
|
|
70
|
-
| `T` | extends `Object` |
|
|
71
|
-
|
|
72
|
-
#### Parameters
|
|
73
|
-
|
|
74
|
-
| Name | Type |
|
|
75
|
-
| :------ | :------ |
|
|
76
|
-
| `userCredentials` | [`UserCredentials`](../interfaces/UserCredentials.md)<`T`\> |
|
|
77
|
-
|
|
78
|
-
#### Returns
|
|
79
|
-
|
|
80
|
-
[`AuthMock`](AuthMock.md)
|
|
81
|
-
|
|
82
|
-
#### Defined in
|
|
83
|
-
|
|
84
|
-
[auth/auth-mock.ts:79](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L79)
|
|
85
|
-
|
|
86
|
-
___
|
|
87
|
-
|
|
88
|
-
### flush
|
|
89
|
-
|
|
90
|
-
▸ **flush**(): `Promise`<`void`\>
|
|
91
|
-
|
|
92
|
-
#### Returns
|
|
93
|
-
|
|
94
|
-
`Promise`<`void`\>
|
|
95
|
-
|
|
96
|
-
#### Defined in
|
|
97
|
-
|
|
98
|
-
[auth/auth-mock.ts:74](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L74)
|
|
99
|
-
|
|
100
|
-
___
|
|
101
|
-
|
|
102
|
-
### linkAdditionalProvider
|
|
103
|
-
|
|
104
|
-
▸ **linkAdditionalProvider**(`provider`): `Promise`<`unknown`\>
|
|
105
|
-
|
|
106
|
-
#### Parameters
|
|
107
|
-
|
|
108
|
-
| Name | Type |
|
|
109
|
-
| :------ | :------ |
|
|
110
|
-
| `provider` | [`AuthProvider`](../modules.md#authprovider) |
|
|
111
|
-
|
|
112
|
-
#### Returns
|
|
113
|
-
|
|
114
|
-
`Promise`<`unknown`\>
|
|
115
|
-
|
|
116
|
-
#### Overrides
|
|
117
|
-
|
|
118
|
-
[AuthService](AuthService.md).[linkAdditionalProvider](AuthService.md#linkadditionalprovider)
|
|
119
|
-
|
|
120
|
-
#### Defined in
|
|
121
|
-
|
|
122
|
-
[auth/auth-mock.ts:66](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L66)
|
|
123
|
-
|
|
124
|
-
___
|
|
125
|
-
|
|
126
|
-
### login
|
|
127
|
-
|
|
128
|
-
▸ **login**<`T`\>(`signData`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
129
|
-
|
|
130
|
-
#### Type parameters
|
|
131
|
-
|
|
132
|
-
| Name | Type |
|
|
133
|
-
| :------ | :------ |
|
|
134
|
-
| `T` | extends `Object` |
|
|
135
|
-
|
|
136
|
-
#### Parameters
|
|
137
|
-
|
|
138
|
-
| Name | Type |
|
|
139
|
-
| :------ | :------ |
|
|
140
|
-
| `signData` | [`SignData`](../interfaces/SignData.md) |
|
|
141
|
-
|
|
142
|
-
#### Returns
|
|
143
|
-
|
|
144
|
-
`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
145
|
-
|
|
146
|
-
#### Overrides
|
|
147
|
-
|
|
148
|
-
[AuthService](AuthService.md).[login](AuthService.md#login)
|
|
149
|
-
|
|
150
|
-
#### Defined in
|
|
151
|
-
|
|
152
|
-
[auth/auth-mock.ts:30](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L30)
|
|
153
|
-
|
|
154
|
-
___
|
|
155
|
-
|
|
156
|
-
### logout
|
|
157
|
-
|
|
158
|
-
▸ **logout**(): `Promise`<`void`\>
|
|
159
|
-
|
|
160
|
-
#### Returns
|
|
161
|
-
|
|
162
|
-
`Promise`<`void`\>
|
|
163
|
-
|
|
164
|
-
#### Overrides
|
|
165
|
-
|
|
166
|
-
[AuthService](AuthService.md).[logout](AuthService.md#logout)
|
|
167
|
-
|
|
168
|
-
#### Defined in
|
|
169
|
-
|
|
170
|
-
[auth/auth-mock.ts:47](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L47)
|
|
171
|
-
|
|
172
|
-
___
|
|
173
|
-
|
|
174
|
-
### onAuthStateChange
|
|
175
|
-
|
|
176
|
-
▸ **onAuthStateChange**<`T`\>(`onChange`): `void`
|
|
177
|
-
|
|
178
|
-
#### Type parameters
|
|
179
|
-
|
|
180
|
-
| Name | Type |
|
|
181
|
-
| :------ | :------ |
|
|
182
|
-
| `T` | extends `Object` |
|
|
183
|
-
|
|
184
|
-
#### Parameters
|
|
185
|
-
|
|
186
|
-
| Name | Type |
|
|
187
|
-
| :------ | :------ |
|
|
188
|
-
| `onChange` | (`userCredentials`: [`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>) => `void` |
|
|
189
|
-
|
|
190
|
-
#### Returns
|
|
191
|
-
|
|
192
|
-
`void`
|
|
193
|
-
|
|
194
|
-
#### Overrides
|
|
195
|
-
|
|
196
|
-
[AuthService](AuthService.md).[onAuthStateChange](AuthService.md#onauthstatechange)
|
|
197
|
-
|
|
198
|
-
#### Defined in
|
|
199
|
-
|
|
200
|
-
[auth/auth-mock.ts:42](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L42)
|
|
201
|
-
|
|
202
|
-
___
|
|
203
|
-
|
|
204
|
-
### resetEmailPassword
|
|
205
|
-
|
|
206
|
-
▸ **resetEmailPassword**(`email`): `Promise`<`void`\>
|
|
207
|
-
|
|
208
|
-
#### Parameters
|
|
209
|
-
|
|
210
|
-
| Name | Type |
|
|
211
|
-
| :------ | :------ |
|
|
212
|
-
| `email` | `string` |
|
|
213
|
-
|
|
214
|
-
#### Returns
|
|
215
|
-
|
|
216
|
-
`Promise`<`void`\>
|
|
217
|
-
|
|
218
|
-
#### Overrides
|
|
219
|
-
|
|
220
|
-
[AuthService](AuthService.md).[resetEmailPassword](AuthService.md#resetemailpassword)
|
|
221
|
-
|
|
222
|
-
#### Defined in
|
|
223
|
-
|
|
224
|
-
[auth/auth-mock.ts:57](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L57)
|
|
225
|
-
|
|
226
|
-
___
|
|
227
|
-
|
|
228
|
-
### signUp
|
|
229
|
-
|
|
230
|
-
▸ **signUp**<`T`\>(`signData`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
231
|
-
|
|
232
|
-
#### Type parameters
|
|
233
|
-
|
|
234
|
-
| Name | Type |
|
|
235
|
-
| :------ | :------ |
|
|
236
|
-
| `T` | extends `Object` |
|
|
237
|
-
|
|
238
|
-
#### Parameters
|
|
239
|
-
|
|
240
|
-
| Name | Type |
|
|
241
|
-
| :------ | :------ |
|
|
242
|
-
| `signData` | [`SignData`](../interfaces/SignData.md) |
|
|
243
|
-
|
|
244
|
-
#### Returns
|
|
245
|
-
|
|
246
|
-
`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
247
|
-
|
|
248
|
-
#### Overrides
|
|
249
|
-
|
|
250
|
-
[AuthService](AuthService.md).[signUp](AuthService.md#signup)
|
|
251
|
-
|
|
252
|
-
#### Defined in
|
|
253
|
-
|
|
254
|
-
[auth/auth-mock.ts:7](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L7)
|
|
255
|
-
|
|
256
|
-
___
|
|
257
|
-
|
|
258
|
-
### unlinkProvider
|
|
259
|
-
|
|
260
|
-
▸ **unlinkProvider**(`provider`): `Promise`<`unknown`\>
|
|
261
|
-
|
|
262
|
-
#### Parameters
|
|
263
|
-
|
|
264
|
-
| Name | Type |
|
|
265
|
-
| :------ | :------ |
|
|
266
|
-
| `provider` | [`AuthProvider`](../modules.md#authprovider) |
|
|
267
|
-
|
|
268
|
-
#### Returns
|
|
269
|
-
|
|
270
|
-
`Promise`<`unknown`\>
|
|
271
|
-
|
|
272
|
-
#### Overrides
|
|
273
|
-
|
|
274
|
-
[AuthService](AuthService.md).[unlinkProvider](AuthService.md#unlinkprovider)
|
|
275
|
-
|
|
276
|
-
#### Defined in
|
|
277
|
-
|
|
278
|
-
[auth/auth-mock.ts:70](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth-mock.ts#L70)
|
|
@@ -1,188 +0,0 @@
|
|
|
1
|
-
[entropic-bond](../README.md) / [Exports](../modules.md) / AuthService
|
|
2
|
-
|
|
3
|
-
# Class: AuthService
|
|
4
|
-
|
|
5
|
-
The AuthService class is an abstract class that defines the interface of an authentication service.
|
|
6
|
-
You should derive from this class to implement your own authentication service.
|
|
7
|
-
|
|
8
|
-
## Hierarchy
|
|
9
|
-
|
|
10
|
-
- **`AuthService`**
|
|
11
|
-
|
|
12
|
-
↳ [`Auth`](Auth.md)
|
|
13
|
-
|
|
14
|
-
↳ [`AuthMock`](AuthMock.md)
|
|
15
|
-
|
|
16
|
-
## Table of contents
|
|
17
|
-
|
|
18
|
-
### Constructors
|
|
19
|
-
|
|
20
|
-
- [constructor](AuthService.md#constructor)
|
|
21
|
-
|
|
22
|
-
### Methods
|
|
23
|
-
|
|
24
|
-
- [linkAdditionalProvider](AuthService.md#linkadditionalprovider)
|
|
25
|
-
- [login](AuthService.md#login)
|
|
26
|
-
- [logout](AuthService.md#logout)
|
|
27
|
-
- [onAuthStateChange](AuthService.md#onauthstatechange)
|
|
28
|
-
- [resetEmailPassword](AuthService.md#resetemailpassword)
|
|
29
|
-
- [signUp](AuthService.md#signup)
|
|
30
|
-
- [unlinkProvider](AuthService.md#unlinkprovider)
|
|
31
|
-
|
|
32
|
-
## Constructors
|
|
33
|
-
|
|
34
|
-
### constructor
|
|
35
|
-
|
|
36
|
-
• **new AuthService**()
|
|
37
|
-
|
|
38
|
-
## Methods
|
|
39
|
-
|
|
40
|
-
### linkAdditionalProvider
|
|
41
|
-
|
|
42
|
-
▸ `Abstract` **linkAdditionalProvider**(`provider`): `Promise`<`unknown`\>
|
|
43
|
-
|
|
44
|
-
#### Parameters
|
|
45
|
-
|
|
46
|
-
| Name | Type |
|
|
47
|
-
| :------ | :------ |
|
|
48
|
-
| `provider` | [`AuthProvider`](../modules.md#authprovider) |
|
|
49
|
-
|
|
50
|
-
#### Returns
|
|
51
|
-
|
|
52
|
-
`Promise`<`unknown`\>
|
|
53
|
-
|
|
54
|
-
#### Defined in
|
|
55
|
-
|
|
56
|
-
[auth/auth.ts:13](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth.ts#L13)
|
|
57
|
-
|
|
58
|
-
___
|
|
59
|
-
|
|
60
|
-
### login
|
|
61
|
-
|
|
62
|
-
▸ `Abstract` **login**<`T`\>(`signData`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
63
|
-
|
|
64
|
-
#### Type parameters
|
|
65
|
-
|
|
66
|
-
| Name | Type |
|
|
67
|
-
| :------ | :------ |
|
|
68
|
-
| `T` | extends `Object` |
|
|
69
|
-
|
|
70
|
-
#### Parameters
|
|
71
|
-
|
|
72
|
-
| Name | Type |
|
|
73
|
-
| :------ | :------ |
|
|
74
|
-
| `signData` | [`SignData`](../interfaces/SignData.md) |
|
|
75
|
-
|
|
76
|
-
#### Returns
|
|
77
|
-
|
|
78
|
-
`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
79
|
-
|
|
80
|
-
#### Defined in
|
|
81
|
-
|
|
82
|
-
[auth/auth.ts:10](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth.ts#L10)
|
|
83
|
-
|
|
84
|
-
___
|
|
85
|
-
|
|
86
|
-
### logout
|
|
87
|
-
|
|
88
|
-
▸ `Abstract` **logout**(): `Promise`<`void`\>
|
|
89
|
-
|
|
90
|
-
#### Returns
|
|
91
|
-
|
|
92
|
-
`Promise`<`void`\>
|
|
93
|
-
|
|
94
|
-
#### Defined in
|
|
95
|
-
|
|
96
|
-
[auth/auth.ts:11](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth.ts#L11)
|
|
97
|
-
|
|
98
|
-
___
|
|
99
|
-
|
|
100
|
-
### onAuthStateChange
|
|
101
|
-
|
|
102
|
-
▸ `Abstract` **onAuthStateChange**<`T`\>(`onChange`): `void`
|
|
103
|
-
|
|
104
|
-
#### Type parameters
|
|
105
|
-
|
|
106
|
-
| Name | Type |
|
|
107
|
-
| :------ | :------ |
|
|
108
|
-
| `T` | extends `Object` |
|
|
109
|
-
|
|
110
|
-
#### Parameters
|
|
111
|
-
|
|
112
|
-
| Name | Type |
|
|
113
|
-
| :------ | :------ |
|
|
114
|
-
| `onChange` | (`userCredentials`: [`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>) => `void` |
|
|
115
|
-
|
|
116
|
-
#### Returns
|
|
117
|
-
|
|
118
|
-
`void`
|
|
119
|
-
|
|
120
|
-
#### Defined in
|
|
121
|
-
|
|
122
|
-
[auth/auth.ts:15](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth.ts#L15)
|
|
123
|
-
|
|
124
|
-
___
|
|
125
|
-
|
|
126
|
-
### resetEmailPassword
|
|
127
|
-
|
|
128
|
-
▸ `Abstract` **resetEmailPassword**(`email`): `Promise`<`void`\>
|
|
129
|
-
|
|
130
|
-
#### Parameters
|
|
131
|
-
|
|
132
|
-
| Name | Type |
|
|
133
|
-
| :------ | :------ |
|
|
134
|
-
| `email` | `string` |
|
|
135
|
-
|
|
136
|
-
#### Returns
|
|
137
|
-
|
|
138
|
-
`Promise`<`void`\>
|
|
139
|
-
|
|
140
|
-
#### Defined in
|
|
141
|
-
|
|
142
|
-
[auth/auth.ts:12](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth.ts#L12)
|
|
143
|
-
|
|
144
|
-
___
|
|
145
|
-
|
|
146
|
-
### signUp
|
|
147
|
-
|
|
148
|
-
▸ `Abstract` **signUp**<`T`\>(`signData`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
149
|
-
|
|
150
|
-
#### Type parameters
|
|
151
|
-
|
|
152
|
-
| Name | Type |
|
|
153
|
-
| :------ | :------ |
|
|
154
|
-
| `T` | extends `Object` |
|
|
155
|
-
|
|
156
|
-
#### Parameters
|
|
157
|
-
|
|
158
|
-
| Name | Type |
|
|
159
|
-
| :------ | :------ |
|
|
160
|
-
| `signData` | [`SignData`](../interfaces/SignData.md) |
|
|
161
|
-
|
|
162
|
-
#### Returns
|
|
163
|
-
|
|
164
|
-
`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
|
|
165
|
-
|
|
166
|
-
#### Defined in
|
|
167
|
-
|
|
168
|
-
[auth/auth.ts:9](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth.ts#L9)
|
|
169
|
-
|
|
170
|
-
___
|
|
171
|
-
|
|
172
|
-
### unlinkProvider
|
|
173
|
-
|
|
174
|
-
▸ `Abstract` **unlinkProvider**(`provider`): `Promise`<`unknown`\>
|
|
175
|
-
|
|
176
|
-
#### Parameters
|
|
177
|
-
|
|
178
|
-
| Name | Type |
|
|
179
|
-
| :------ | :------ |
|
|
180
|
-
| `provider` | [`AuthProvider`](../modules.md#authprovider) |
|
|
181
|
-
|
|
182
|
-
#### Returns
|
|
183
|
-
|
|
184
|
-
`Promise`<`unknown`\>
|
|
185
|
-
|
|
186
|
-
#### Defined in
|
|
187
|
-
|
|
188
|
-
[auth/auth.ts:14](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/auth.ts#L14)
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
[entropic-bond](../README.md) / [Exports](../modules.md) / CloudFunctions
|
|
2
|
-
|
|
3
|
-
# Class: CloudFunctions
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [error](CloudFunctions.md#error)
|
|
10
|
-
|
|
11
|
-
### Accessors
|
|
12
|
-
|
|
13
|
-
- [instance](CloudFunctions.md#instance)
|
|
14
|
-
|
|
15
|
-
### Methods
|
|
16
|
-
|
|
17
|
-
- [getFunction](CloudFunctions.md#getfunction)
|
|
18
|
-
- [getRawFunction](CloudFunctions.md#getrawfunction)
|
|
19
|
-
- [useCloudFunctionsService](CloudFunctions.md#usecloudfunctionsservice)
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
### error
|
|
24
|
-
|
|
25
|
-
▪ `Static` **error**: `Object`
|
|
26
|
-
|
|
27
|
-
#### Type declaration
|
|
28
|
-
|
|
29
|
-
| Name | Type |
|
|
30
|
-
| :------ | :------ |
|
|
31
|
-
| `shouldBeRegistered` | `string` |
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[cloud-functions/cloud-functions.ts:14](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions.ts#L14)
|
|
36
|
-
|
|
37
|
-
## Accessors
|
|
38
|
-
|
|
39
|
-
### instance
|
|
40
|
-
|
|
41
|
-
• `Static` `get` **instance**(): [`CloudFunctions`](CloudFunctions.md)
|
|
42
|
-
|
|
43
|
-
#### Returns
|
|
44
|
-
|
|
45
|
-
[`CloudFunctions`](CloudFunctions.md)
|
|
46
|
-
|
|
47
|
-
#### Defined in
|
|
48
|
-
|
|
49
|
-
[cloud-functions/cloud-functions.ts:22](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions.ts#L22)
|
|
50
|
-
|
|
51
|
-
## Methods
|
|
52
|
-
|
|
53
|
-
### getFunction
|
|
54
|
-
|
|
55
|
-
▸ **getFunction**<`P`, `R`\>(`cloudFunction`): [`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
|
|
56
|
-
|
|
57
|
-
#### Type parameters
|
|
58
|
-
|
|
59
|
-
| Name | Type |
|
|
60
|
-
| :------ | :------ |
|
|
61
|
-
| `P` | `P` |
|
|
62
|
-
| `R` | `void` |
|
|
63
|
-
|
|
64
|
-
#### Parameters
|
|
65
|
-
|
|
66
|
-
| Name | Type |
|
|
67
|
-
| :------ | :------ |
|
|
68
|
-
| `cloudFunction` | `string` |
|
|
69
|
-
|
|
70
|
-
#### Returns
|
|
71
|
-
|
|
72
|
-
[`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
|
|
73
|
-
|
|
74
|
-
#### Defined in
|
|
75
|
-
|
|
76
|
-
[cloud-functions/cloud-functions.ts:31](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions.ts#L31)
|
|
77
|
-
|
|
78
|
-
___
|
|
79
|
-
|
|
80
|
-
### getRawFunction
|
|
81
|
-
|
|
82
|
-
▸ **getRawFunction**<`P`, `R`\>(`cloudFunction`): [`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
|
|
83
|
-
|
|
84
|
-
#### Type parameters
|
|
85
|
-
|
|
86
|
-
| Name |
|
|
87
|
-
| :------ |
|
|
88
|
-
| `P` |
|
|
89
|
-
| `R` |
|
|
90
|
-
|
|
91
|
-
#### Parameters
|
|
92
|
-
|
|
93
|
-
| Name | Type |
|
|
94
|
-
| :------ | :------ |
|
|
95
|
-
| `cloudFunction` | `string` |
|
|
96
|
-
|
|
97
|
-
#### Returns
|
|
98
|
-
|
|
99
|
-
[`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
|
|
100
|
-
|
|
101
|
-
#### Defined in
|
|
102
|
-
|
|
103
|
-
[cloud-functions/cloud-functions.ts:27](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions.ts#L27)
|
|
104
|
-
|
|
105
|
-
___
|
|
106
|
-
|
|
107
|
-
### useCloudFunctionsService
|
|
108
|
-
|
|
109
|
-
▸ `Static` **useCloudFunctionsService**(`cloudFunctionsService`): `void`
|
|
110
|
-
|
|
111
|
-
#### Parameters
|
|
112
|
-
|
|
113
|
-
| Name | Type |
|
|
114
|
-
| :------ | :------ |
|
|
115
|
-
| `cloudFunctionsService` | [`CloudFunctionsService`](../interfaces/CloudFunctionsService.md) |
|
|
116
|
-
|
|
117
|
-
#### Returns
|
|
118
|
-
|
|
119
|
-
`void`
|
|
120
|
-
|
|
121
|
-
#### Defined in
|
|
122
|
-
|
|
123
|
-
[cloud-functions/cloud-functions.ts:16](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions.ts#L16)
|
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
[entropic-bond](../README.md) / [Exports](../modules.md) / CloudFunctionsMock
|
|
2
|
-
|
|
3
|
-
# Class: CloudFunctionsMock
|
|
4
|
-
|
|
5
|
-
## Implements
|
|
6
|
-
|
|
7
|
-
- [`CloudFunctionsService`](../interfaces/CloudFunctionsService.md)
|
|
8
|
-
|
|
9
|
-
## Table of contents
|
|
10
|
-
|
|
11
|
-
### Constructors
|
|
12
|
-
|
|
13
|
-
- [constructor](CloudFunctionsMock.md#constructor)
|
|
14
|
-
|
|
15
|
-
### Methods
|
|
16
|
-
|
|
17
|
-
- [callFunction](CloudFunctionsMock.md#callfunction)
|
|
18
|
-
- [retrieveFunction](CloudFunctionsMock.md#retrievefunction)
|
|
19
|
-
|
|
20
|
-
## Constructors
|
|
21
|
-
|
|
22
|
-
### constructor
|
|
23
|
-
|
|
24
|
-
• **new CloudFunctionsMock**(`registeredFunctions`)
|
|
25
|
-
|
|
26
|
-
#### Parameters
|
|
27
|
-
|
|
28
|
-
| Name | Type |
|
|
29
|
-
| :------ | :------ |
|
|
30
|
-
| `registeredFunctions` | `FunctionCollection` |
|
|
31
|
-
|
|
32
|
-
#### Defined in
|
|
33
|
-
|
|
34
|
-
[cloud-functions/cloud-functions-mock.ts:8](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions-mock.ts#L8)
|
|
35
|
-
|
|
36
|
-
## Methods
|
|
37
|
-
|
|
38
|
-
### callFunction
|
|
39
|
-
|
|
40
|
-
▸ **callFunction**<`P`, `R`\>(`func`, `params`): `Promise`<`R`\>
|
|
41
|
-
|
|
42
|
-
#### Type parameters
|
|
43
|
-
|
|
44
|
-
| Name |
|
|
45
|
-
| :------ |
|
|
46
|
-
| `P` |
|
|
47
|
-
| `R` |
|
|
48
|
-
|
|
49
|
-
#### Parameters
|
|
50
|
-
|
|
51
|
-
| Name | Type |
|
|
52
|
-
| :------ | :------ |
|
|
53
|
-
| `func` | [`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\> |
|
|
54
|
-
| `params` | `P` |
|
|
55
|
-
|
|
56
|
-
#### Returns
|
|
57
|
-
|
|
58
|
-
`Promise`<`R`\>
|
|
59
|
-
|
|
60
|
-
#### Implementation of
|
|
61
|
-
|
|
62
|
-
[CloudFunctionsService](../interfaces/CloudFunctionsService.md).[callFunction](../interfaces/CloudFunctionsService.md#callfunction)
|
|
63
|
-
|
|
64
|
-
#### Defined in
|
|
65
|
-
|
|
66
|
-
[cloud-functions/cloud-functions-mock.ts:16](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions-mock.ts#L16)
|
|
67
|
-
|
|
68
|
-
___
|
|
69
|
-
|
|
70
|
-
### retrieveFunction
|
|
71
|
-
|
|
72
|
-
▸ **retrieveFunction**<`P`, `R`\>(`cloudFunction`): [`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
|
|
73
|
-
|
|
74
|
-
#### Type parameters
|
|
75
|
-
|
|
76
|
-
| Name |
|
|
77
|
-
| :------ |
|
|
78
|
-
| `P` |
|
|
79
|
-
| `R` |
|
|
80
|
-
|
|
81
|
-
#### Parameters
|
|
82
|
-
|
|
83
|
-
| Name | Type |
|
|
84
|
-
| :------ | :------ |
|
|
85
|
-
| `cloudFunction` | `string` |
|
|
86
|
-
|
|
87
|
-
#### Returns
|
|
88
|
-
|
|
89
|
-
[`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
|
|
90
|
-
|
|
91
|
-
#### Implementation of
|
|
92
|
-
|
|
93
|
-
[CloudFunctionsService](../interfaces/CloudFunctionsService.md).[retrieveFunction](../interfaces/CloudFunctionsService.md#retrievefunction)
|
|
94
|
-
|
|
95
|
-
#### Defined in
|
|
96
|
-
|
|
97
|
-
[cloud-functions/cloud-functions-mock.ts:12](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions-mock.ts#L12)
|