entropic-bond 1.50.0 → 1.50.1

package/docs/classes/ServerAuthMock.md

@@ -1,176 +0,0 @@
-[entropic-bond](../README.md) / [Exports](../modules.md) / ServerAuthMock
-
-# Class: ServerAuthMock
-
-## Hierarchy
-
-- [`ServerAuthService`](ServerAuthService.md)
-
-  ↳ **`ServerAuthMock`**
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ServerAuthMock.md#constructor)
-
-### Accessors
-
-- [userCredentials](ServerAuthMock.md#usercredentials)
-
-### Methods
-
-- [deleteUser](ServerAuthMock.md#deleteuser)
-- [getUser](ServerAuthMock.md#getuser)
-- [setCustomCredentials](ServerAuthMock.md#setcustomcredentials)
-- [updateUser](ServerAuthMock.md#updateuser)
-
-## Constructors
-
-### constructor
-
-• **new ServerAuthMock**(`userCredentials`)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userCredentials` | [`Collection`](../interfaces/Collection.md)<[`UserCredentials`](../interfaces/UserCredentials.md)<{}\>\> |
-
-#### Overrides
-
-[ServerAuthService](ServerAuthService.md).[constructor](ServerAuthService.md#constructor)
-
-#### Defined in
-
-[server-auth/server-auth-mock.ts:6](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth-mock.ts#L6)
-
-## Accessors
-
-### userCredentials
-
-• `get` **userCredentials**(): [`Collection`](../interfaces/Collection.md)<[`UserCredentials`](../interfaces/UserCredentials.md)<{}\>\>
-
-#### Returns
-
-[`Collection`](../interfaces/Collection.md)<[`UserCredentials`](../interfaces/UserCredentials.md)<{}\>\>
-
-#### Defined in
-
-[server-auth/server-auth-mock.ts:39](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth-mock.ts#L39)
-
-## Methods
-
-### deleteUser
-
-▸ **deleteUser**(`userId`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Overrides
-
-[ServerAuthService](ServerAuthService.md).[deleteUser](ServerAuthService.md#deleteuser)
-
-#### Defined in
-
-[server-auth/server-auth-mock.ts:34](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth-mock.ts#L34)
-
-___
-
-### getUser
-
-▸ **getUser**<`T`\>(`userId`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`CustomCredentials`](../interfaces/CustomCredentials.md) |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-
-#### Returns
-
-`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Overrides
-
-[ServerAuthService](ServerAuthService.md).[getUser](ServerAuthService.md#getuser)
-
-#### Defined in
-
-[server-auth/server-auth-mock.ts:11](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth-mock.ts#L11)
-
-___
-
-### setCustomCredentials
-
-▸ **setCustomCredentials**<`T`\>(`userId`, `customCredentials`): `Promise`<`void`\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`CustomCredentials`](../interfaces/CustomCredentials.md) |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-| `customCredentials` | `T` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Overrides
-
-[ServerAuthService](ServerAuthService.md).[setCustomCredentials](ServerAuthService.md#setcustomcredentials)
-
-#### Defined in
-
-[server-auth/server-auth-mock.ts:17](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth-mock.ts#L17)
-
-___
-
-### updateUser
-
-▸ **updateUser**<`T`\>(`userId`, `credentials`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`CustomCredentials`](../interfaces/CustomCredentials.md) |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-| `credentials` | `Partial`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\> |
-
-#### Returns
-
-`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Overrides
-
-[ServerAuthService](ServerAuthService.md).[updateUser](ServerAuthService.md#updateuser)
-
-#### Defined in
-
-[server-auth/server-auth-mock.ts:24](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth-mock.ts#L24)

package/docs/classes/ServerAuthService.md

@@ -1,130 +0,0 @@
-[entropic-bond](../README.md) / [Exports](../modules.md) / ServerAuthService
-
-# Class: ServerAuthService
-
-## Hierarchy
-
-- **`ServerAuthService`**
-
-  ↳ [`ServerAuth`](ServerAuth.md)
-
-  ↳ [`ServerAuthMock`](ServerAuthMock.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](ServerAuthService.md#constructor)
-
-### Methods
-
-- [deleteUser](ServerAuthService.md#deleteuser)
-- [getUser](ServerAuthService.md#getuser)
-- [setCustomCredentials](ServerAuthService.md#setcustomcredentials)
-- [updateUser](ServerAuthService.md#updateuser)
-
-## Constructors
-
-### constructor
-
-• **new ServerAuthService**()
-
-## Methods
-
-### deleteUser
-
-▸ `Abstract` **deleteUser**(`userId`): `Promise`<`void`\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[server-auth/server-auth.ts:11](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth.ts#L11)
-
-___
-
-### getUser
-
-▸ `Abstract` **getUser**<`T`\>(`userId`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`CustomCredentials`](../interfaces/CustomCredentials.md) |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-
-#### Returns
-
-`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Defined in
-
-[server-auth/server-auth.ts:9](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth.ts#L9)
-
-___
-
-### setCustomCredentials
-
-▸ `Abstract` **setCustomCredentials**<`T`\>(`userId`, `customCredentials`): `Promise`<`void`\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`CustomCredentials`](../interfaces/CustomCredentials.md) |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-| `customCredentials` | `T` |
-
-#### Returns
-
-`Promise`<`void`\>
-
-#### Defined in
-
-[server-auth/server-auth.ts:8](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth.ts#L8)
-
-___
-
-### updateUser
-
-▸ `Abstract` **updateUser**<`T`\>(`userId`, `credentials`): `Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`CustomCredentials`](../interfaces/CustomCredentials.md) |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-| `credentials` | `Partial`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\> |
-
-#### Returns
-
-`Promise`<[`UserCredentials`](../interfaces/UserCredentials.md)<`T`\>\>
-
-#### Defined in
-
-[server-auth/server-auth.ts:10](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/server-auth/server-auth.ts#L10)

package/docs/classes/Store.md

@@ -1,218 +0,0 @@
-[entropic-bond](../README.md) / [Exports](../modules.md) / Store
-
-# Class: Store
-
-The store is the main entry point for the data access layer.
-It provides methods to retrieve models for collections and subcollections.
-It also provides methods to populate property references with actual data from the store.
-You need to register a data source before using the store.
-
-**`Example`**
-
-```ts
-// Register a data source
-Store.useDataSource( new FirestoreDataSource( firebase.firestore() ) )
-// Retrieve a model for a collection
-const model = Store.getModel( 'User' )
-// Retrieve a model for a subcollection
-const model = Store.getModelForSubCollection( user, 'Posts' )
-// Populate property references
-const user = await Store.populate( user )
-```
-
-## Table of contents
-
-### Properties
-
-- [error](Store.md#error)
-
-### Accessors
-
-- [dataSource](Store.md#datasource)
-
-### Methods
-
-- [getModel](Store.md#getmodel)
-- [getModelForSubCollection](Store.md#getmodelforsubcollection)
-- [isPopulated](Store.md#ispopulated)
-- [populate](Store.md#populate)
-- [useDataSource](Store.md#usedatasource)
-
-## Properties
-
-### error
-
-▪ `Static` **error**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `shouldBeRegistered` | `string` |
-
-#### Defined in
-
-[store/store.ts:23](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/store/store.ts#L23)
-
-## Accessors
-
-### dataSource
-
-• `Static` `get` **dataSource**(): [`DataSource`](DataSource.md)
-
-The data source currently used by the store
-
-#### Returns
-
-[`DataSource`](DataSource.md)
-
-the data source
-
-#### Defined in
-
-[store/store.ts:38](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/store/store.ts#L38)
-
-## Methods
-
-### getModel
-
-▸ `Static` **getModel**<`T`\>(`classId`): [`Model`](Model.md)<`T`\>
-
-Retrieves a model for a collection
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`Persistent`](Persistent.md)<`T`\> |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `classId` | `string` \| `T` | the class name or an instance of the document type stored in the collection |
-
-#### Returns
-
-[`Model`](Model.md)<`T`\>
-
-the model for the collection
-
-#### Defined in
-
-[store/store.ts:47](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/store/store.ts#L47)
-
-___
-
-### getModelForSubCollection
-
-▸ `Static` **getModelForSubCollection**<`T`\>(`document`, `subCollection`): [`Model`](Model.md)<`T`\>
-
-Retrieves a model for a subcollection
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`Persistent`](Persistent.md)<`T`\> |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `document` | [`Persistent`](Persistent.md) | the persistent object that owns the subcollection |
-| `subCollection` | `string` | the name of the subcollection |
-
-#### Returns
-
-[`Model`](Model.md)<`T`\>
-
-the model for the subcollection
-
-#### Defined in
-
-[store/store.ts:58](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/store/store.ts#L58)
-
-___
-
-### isPopulated
-
-▸ `Static` **isPopulated**<`T`\>(`instance`): `boolean`
-
-Checks if an instance is populated
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`Persistent`](Persistent.md)<`T`\> |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `instance` | `T` \| readonly `T`[] | the instance or array of instances to be checked |
-
-#### Returns
-
-`boolean`
-
-true if the instance is populated
-
-#### Defined in
-
-[store/store.ts:100](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/store/store.ts#L100)
-
-___
-
-### populate
-
-▸ `Static` **populate**<`T`\>(`instance`): `Promise`<`T`\>
-
-Populates property references with actual data from the store.
-It will not retrieve data if the instance is already populated
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | extends [`Persistent`](Persistent.md) \| [`Persistent`](Persistent.md)[] |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `instance` | `T` | the data to be populated. |
-
-#### Returns
-
-`Promise`<`T`\>
-
-the populated instance
-
-#### Defined in
-
-[store/store.ts:69](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/store/store.ts#L69)
-
-___
-
-### useDataSource
-
-▸ `Static` **useDataSource**(`dataSource`): `void`
-
-Registers a data source to be used by the store.
-You need to register a data source before using the store.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `dataSource` | [`DataSource`](DataSource.md) | the data source to be used by the store |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[store/store.ts:30](https://github.com/entropic-bond/entropic-bond/blob/c9dd385/src/store/store.ts#L30)