entropic-bond 1.49.0 → 1.50.0

package/docs/interfaces/CloudFunctionsService.md

@@ -0,0 +1,69 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / CloudFunctionsService
+
+# Interface: CloudFunctionsService
+
+## Implemented by
+
+- [`CloudFunctionsMock`](../classes/CloudFunctionsMock.md)
+
+## Table of contents
+
+### Methods
+
+- [callFunction](CloudFunctionsService.md#callfunction)
+- [retrieveFunction](CloudFunctionsService.md#retrievefunction)
+
+## Methods
+
+### callFunction
+
+▸ **callFunction**<`P`, `R`\>(`func`, `params`): `Promise`<`R`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `P` |
+| `R` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `func` | [`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\> |
+| `params` | `P` |
+
+#### Returns
+
+`Promise`<`R`\>
+
+#### Defined in
+
+[cloud-functions/cloud-functions.ts:8](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions.ts#L8)
+
+___
+
+### retrieveFunction
+
+▸ **retrieveFunction**<`P`, `R`\>(`cloudFunction`): [`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `P` |
+| `R` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cloudFunction` | `string` |
+
+#### Returns
+
+[`CloudFunction`](../modules.md#cloudfunction)<`P`, `R`\>
+
+#### Defined in
+
+[cloud-functions/cloud-functions.ts:7](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-functions/cloud-functions.ts#L7)

package/docs/interfaces/Collection.md

@@ -0,0 +1,13 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / Collection
+
+# Interface: Collection<T\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Indexable
+
+▪ [key: `string` \| `symbol`]: `T`

package/docs/interfaces/CustomCredentials.md

@@ -0,0 +1,7 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / CustomCredentials
+
+# Interface: CustomCredentials
+
+## Indexable
+
+▪ [key: `string`]: `unknown`

package/docs/interfaces/DocumentReference.md

@@ -0,0 +1,49 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / DocumentReference
+
+# Interface: DocumentReference
+
+Stores information about a reference in another collection.
+
+## Table of contents
+
+### Properties
+
+- [\_\_className](DocumentReference.md#__classname)
+- [\_\_documentReference](DocumentReference.md#__documentreference)
+- [id](DocumentReference.md#id)
+
+## Properties
+
+### \_\_className
+
+• **\_\_className**: `string`
+
+#### Defined in
+
+[persistent/persistent.ts:45](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/persistent/persistent.ts#L45)
+
+___
+
+### \_\_documentReference
+
+• **\_\_documentReference**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `storedInCollection` | `string` |
+
+#### Defined in
+
+[persistent/persistent.ts:46](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/persistent/persistent.ts#L46)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[persistent/persistent.ts:44](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/persistent/persistent.ts#L44)

package/docs/interfaces/JsonRawData.md

@@ -0,0 +1,7 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / JsonRawData
+
+# Interface: JsonRawData
+
+## Indexable
+
+▪ [collection: `string`]: { `[documentId: string]`: [`PersistentObject`](../modules.md#persistentobject)<[`Persistent`](../classes/Persistent.md)\>;  }

package/docs/interfaces/SignData.md

@@ -0,0 +1,63 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / SignData
+
+# Interface: SignData
+
+## Table of contents
+
+### Properties
+
+- [authProvider](SignData.md#authprovider)
+- [email](SignData.md#email)
+- [name](SignData.md#name)
+- [password](SignData.md#password)
+- [verificationLink](SignData.md#verificationlink)
+
+## Properties
+
+### authProvider
+
+• **authProvider**: [`AuthProvider`](../modules.md#authprovider)
+
+#### Defined in
+
+[auth/user-auth-types.ts:16](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L16)
+
+___
+
+### email
+
+• `Optional` **email**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:17](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L17)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:19](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L19)
+
+___
+
+### password
+
+• `Optional` **password**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:18](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L18)
+
+___
+
+### verificationLink
+
+• `Optional` **verificationLink**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:20](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L20)

package/docs/interfaces/StoreParams.md

@@ -0,0 +1,52 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / StoreParams
+
+# Interface: StoreParams
+
+## Table of contents
+
+### Properties
+
+- [cloudStorageProvider](StoreParams.md#cloudstorageprovider)
+- [data](StoreParams.md#data)
+- [fileName](StoreParams.md#filename)
+- [progress](StoreParams.md#progress)
+
+## Properties
+
+### cloudStorageProvider
+
+• `Optional` **cloudStorageProvider**: [`CloudStorage`](../classes/CloudStorage.md)
+
+#### Defined in
+
+[cloud-storage/stored-file.ts:16](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/stored-file.ts#L16)
+
+___
+
+### data
+
+• `Optional` **data**: [`StorableData`](../modules.md#storabledata)
+
+#### Defined in
+
+[cloud-storage/stored-file.ts:13](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/stored-file.ts#L13)
+
+___
+
+### fileName
+
+• `Optional` **fileName**: `string`
+
+#### Defined in
+
+[cloud-storage/stored-file.ts:14](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/stored-file.ts#L14)
+
+___
+
+### progress
+
+• `Optional` **progress**: [`UploadProgress`](../modules.md#uploadprogress)
+
+#### Defined in
+
+[cloud-storage/stored-file.ts:15](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/stored-file.ts#L15)

package/docs/interfaces/StoredFileChange.md

@@ -0,0 +1,41 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / StoredFileChange
+
+# Interface: StoredFileChange
+
+## Table of contents
+
+### Properties
+
+- [event](StoredFileChange.md#event)
+- [pendingData](StoredFileChange.md#pendingdata)
+- [storedFile](StoredFileChange.md#storedfile)
+
+## Properties
+
+### event
+
+• **event**: [`StoredFileEvent`](../enums/StoredFileEvent.md)
+
+#### Defined in
+
+[cloud-storage/stored-file.ts:7](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/stored-file.ts#L7)
+
+___
+
+### pendingData
+
+• `Optional` **pendingData**: [`StorableData`](../modules.md#storabledata)
+
+#### Defined in
+
+[cloud-storage/stored-file.ts:8](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/stored-file.ts#L8)
+
+___
+
+### storedFile
+
+• **storedFile**: [`StoredFile`](../classes/StoredFile.md)
+
+#### Defined in
+
+[cloud-storage/stored-file.ts:9](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/stored-file.ts#L9)

package/docs/interfaces/UploadControl.md

@@ -0,0 +1,90 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / UploadControl
+
+# Interface: UploadControl
+
+## Table of contents
+
+### Properties
+
+- [cancel](UploadControl.md#cancel)
+- [onProgress](UploadControl.md#onprogress)
+- [pause](UploadControl.md#pause)
+- [resume](UploadControl.md#resume)
+
+## Properties
+
+### cancel
+
+• **cancel**: () => `void`
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[cloud-storage/cloud-storage.ts:12](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/cloud-storage.ts#L12)
+
+___
+
+### onProgress
+
+• **onProgress**: (`callback`: [`UploadProgress`](../modules.md#uploadprogress)) => `void`
+
+#### Type declaration
+
+▸ (`callback`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `callback` | [`UploadProgress`](../modules.md#uploadprogress) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[cloud-storage/cloud-storage.ts:13](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/cloud-storage.ts#L13)
+
+___
+
+### pause
+
+• **pause**: () => `void`
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[cloud-storage/cloud-storage.ts:10](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/cloud-storage.ts#L10)
+
+___
+
+### resume
+
+• **resume**: () => `void`
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[cloud-storage/cloud-storage.ts:11](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/cloud-storage/cloud-storage.ts#L11)

package/docs/interfaces/UserCredentials.md

@@ -0,0 +1,113 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / UserCredentials
+
+# Interface: UserCredentials<T\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | extends `Object` = {} |
+
+## Table of contents
+
+### Properties
+
+- [creationDate](UserCredentials.md#creationdate)
+- [customData](UserCredentials.md#customdata)
+- [email](UserCredentials.md#email)
+- [emailVerified](UserCredentials.md#emailverified)
+- [id](UserCredentials.md#id)
+- [lastLogin](UserCredentials.md#lastlogin)
+- [name](UserCredentials.md#name)
+- [phoneNumber](UserCredentials.md#phonenumber)
+- [pictureUrl](UserCredentials.md#pictureurl)
+
+## Properties
+
+### creationDate
+
+• `Optional` **creationDate**: `number`
+
+#### Defined in
+
+[auth/user-auth-types.ts:10](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L10)
+
+___
+
+### customData
+
+• `Optional` **customData**: `T`
+
+#### Defined in
+
+[auth/user-auth-types.ts:8](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L8)
+
+___
+
+### email
+
+• **email**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:3](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L3)
+
+___
+
+### emailVerified
+
+• `Optional` **emailVerified**: `boolean`
+
+#### Defined in
+
+[auth/user-auth-types.ts:7](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L7)
+
+___
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:2](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L2)
+
+___
+
+### lastLogin
+
+• `Optional` **lastLogin**: `number`
+
+#### Defined in
+
+[auth/user-auth-types.ts:9](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L9)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:4](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L4)
+
+___
+
+### phoneNumber
+
+• `Optional` **phoneNumber**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:6](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L6)
+
+___
+
+### pictureUrl
+
+• `Optional` **pictureUrl**: `string`
+
+#### Defined in
+
+[auth/user-auth-types.ts:5](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/auth/user-auth-types.ts#L5)

package/docs/interfaces/Values.md

@@ -0,0 +1,17 @@
+[entropic-bond](../README.md) / [Exports](../modules.md) / Values
+
+# Interface: Values
+
+A map of key-value pairs
+
+**`Param`**
+
+the name of the variable
+
+**`Param`**
+
+the value of the variable
+
+## Indexable
+
+▪ [varName: `string`]: `string`