@reactionary/source 0.3.0 → 0.3.2

package/documentation/docs/providers/identity.provider.md

@@ -0,0 +1,194 @@
+[**@reactionary/core**](README.md)
+
+***
+
+[@reactionary/core](README.md) / identity.provider
+
+# identity.provider
+
+## Classes
+
+### `abstract` IdentityProvider
+
+Defined in: [identity.provider.ts:7](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/identity.provider.ts#L7)
+
+Base capability provider, responsible for mutations (changes) and queries (fetches)
+for a given business object domain.
+
+#### Extends
+
+- [`BaseProvider`](base.provider.md#baseprovider)
+
+#### Constructors
+
+##### Constructor
+
+> **new IdentityProvider**(`cache`, `context`): [`IdentityProvider`](#identityprovider)
+
+Defined in: [base.provider.ts:13](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L13)
+
+###### Parameters
+
+###### cache
+
+`Cache`
+
+###### context
+
+`RequestContext`
+
+###### Returns
+
+[`IdentityProvider`](#identityprovider)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`constructor`](base.provider.md#constructor)
+
+#### Properties
+
+##### cache
+
+> `protected` **cache**: `Cache`
+
+Defined in: [base.provider.ts:10](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L10)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`cache`](base.provider.md#cache)
+
+##### context
+
+> `protected` **context**: `RequestContext`
+
+Defined in: [base.provider.ts:11](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L11)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`context`](base.provider.md#context)
+
+#### Methods
+
+##### generateCacheKeyForQuery()
+
+> `protected` **generateCacheKeyForQuery**(`scope`, `query`): `string`
+
+Defined in: [base.provider.ts:32](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L32)
+
+###### Parameters
+
+###### scope
+
+`string`
+
+###### query
+
+`object`
+
+###### Returns
+
+`string`
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateCacheKeyForQuery`](base.provider.md#generatecachekeyforquery)
+
+##### generateDependencyIdsForModel()
+
+> **generateDependencyIdsForModel**(`model`): `string`[]
+
+Defined in: [base.provider.ts:18](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L18)
+
+###### Parameters
+
+###### model
+
+`unknown`
+
+###### Returns
+
+`string`[]
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateDependencyIdsForModel`](base.provider.md#generatedependencyidsformodel)
+
+##### getResourceName()
+
+> `protected` **getResourceName**(): `string`
+
+Defined in: [identity.provider.ts:13](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/identity.provider.ts#L13)
+
+Returns the abstract resource name provided by the remote system.
+
+###### Returns
+
+`string`
+
+###### Overrides
+
+[`BaseProvider`](base.provider.md#baseprovider).[`getResourceName`](base.provider.md#getresourcename)
+
+##### getSelf()
+
+> `abstract` **getSelf**(`payload`): `Promise`\<`Result`\<`Identity`\>\>
+
+Defined in: [identity.provider.ts:8](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/identity.provider.ts#L8)
+
+###### Parameters
+
+###### payload
+
+`IdentityQuerySelf`
+
+###### Returns
+
+`Promise`\<`Result`\<`Identity`\>\>
+
+##### login()
+
+> `abstract` **login**(`payload`): `Promise`\<`Result`\<`Identity`\>\>
+
+Defined in: [identity.provider.ts:9](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/identity.provider.ts#L9)
+
+###### Parameters
+
+###### payload
+
+`IdentityMutationLogin`
+
+###### Returns
+
+`Promise`\<`Result`\<`Identity`\>\>
+
+##### logout()
+
+> `abstract` **logout**(`payload`): `Promise`\<`Result`\<`Identity`\>\>
+
+Defined in: [identity.provider.ts:10](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/identity.provider.ts#L10)
+
+###### Parameters
+
+###### payload
+
+`IdentityMutationLogout`
+
+###### Returns
+
+`Promise`\<`Result`\<`Identity`\>\>
+
+##### register()
+
+> `abstract` **register**(`payload`): `Promise`\<`Result`\<`Identity`\>\>
+
+Defined in: [identity.provider.ts:11](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/identity.provider.ts#L11)
+
+###### Parameters
+
+###### payload
+
+`IdentityMutationRegister`
+
+###### Returns
+
+`Promise`\<`Result`\<`Identity`\>\>

package/documentation/docs/providers/inventory.provider.md

@@ -0,0 +1,162 @@
+[**@reactionary/core**](README.md)
+
+***
+
+[@reactionary/core](README.md) / inventory.provider
+
+# inventory.provider
+
+## Classes
+
+### `abstract` InventoryProvider
+
+Defined in: [inventory.provider.ts:8](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/inventory.provider.ts#L8)
+
+Base capability provider, responsible for mutations (changes) and queries (fetches)
+for a given business object domain.
+
+#### Extends
+
+- [`BaseProvider`](base.provider.md#baseprovider)
+
+#### Constructors
+
+##### Constructor
+
+> **new InventoryProvider**(`cache`, `context`): [`InventoryProvider`](#inventoryprovider)
+
+Defined in: [base.provider.ts:13](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L13)
+
+###### Parameters
+
+###### cache
+
+`Cache`
+
+###### context
+
+`RequestContext`
+
+###### Returns
+
+[`InventoryProvider`](#inventoryprovider)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`constructor`](base.provider.md#constructor)
+
+#### Properties
+
+##### cache
+
+> `protected` **cache**: `Cache`
+
+Defined in: [base.provider.ts:10](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L10)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`cache`](base.provider.md#cache)
+
+##### context
+
+> `protected` **context**: `RequestContext`
+
+Defined in: [base.provider.ts:11](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L11)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`context`](base.provider.md#context)
+
+#### Methods
+
+##### createEmptyInventory()
+
+> `protected` **createEmptyInventory**(`key`): `Inventory`
+
+Defined in: [inventory.provider.ts:15](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/inventory.provider.ts#L15)
+
+###### Parameters
+
+###### key
+
+`InventoryIdentifier`
+
+###### Returns
+
+`Inventory`
+
+##### generateCacheKeyForQuery()
+
+> `protected` **generateCacheKeyForQuery**(`scope`, `query`): `string`
+
+Defined in: [base.provider.ts:32](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L32)
+
+###### Parameters
+
+###### scope
+
+`string`
+
+###### query
+
+`object`
+
+###### Returns
+
+`string`
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateCacheKeyForQuery`](base.provider.md#generatecachekeyforquery)
+
+##### generateDependencyIdsForModel()
+
+> **generateDependencyIdsForModel**(`model`): `string`[]
+
+Defined in: [base.provider.ts:18](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L18)
+
+###### Parameters
+
+###### model
+
+`unknown`
+
+###### Returns
+
+`string`[]
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateDependencyIdsForModel`](base.provider.md#generatedependencyidsformodel)
+
+##### getBySKU()
+
+> `abstract` **getBySKU**(`payload`): `Promise`\<`Result`\<`Inventory`, `NotFoundError`\>\>
+
+Defined in: [inventory.provider.ts:9](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/inventory.provider.ts#L9)
+
+###### Parameters
+
+###### payload
+
+`InventoryQueryBySKU`
+
+###### Returns
+
+`Promise`\<`Result`\<`Inventory`, `NotFoundError`\>\>
+
+##### getResourceName()
+
+> `protected` **getResourceName**(): `string`
+
+Defined in: [inventory.provider.ts:11](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/inventory.provider.ts#L11)
+
+Returns the abstract resource name provided by the remote system.
+
+###### Returns
+
+`string`
+
+###### Overrides
+
+[`BaseProvider`](base.provider.md#baseprovider).[`getResourceName`](base.provider.md#getresourcename)

package/documentation/docs/providers/order-search.provider.md

@@ -0,0 +1,155 @@
+[**@reactionary/core**](README.md)
+
+***
+
+[@reactionary/core](README.md) / order-search.provider
+
+# order-search.provider
+
+## Classes
+
+### `abstract` OrderSearchProvider
+
+Defined in: [order-search.provider.ts:12](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/order-search.provider.ts#L12)
+
+This provider handles order search operations. In some situations you may have different providers for order history listing and detail retrieval.
+The order search is primarily focused on searching and listing orders based on various criteria, and returns only summary information about each order.
+
+Usecase: An e-commerce platform wants to provide customers with a way to search through their past orders using filters like date range, order status, or total amount spent.
+
+#### Extends
+
+- [`BaseProvider`](base.provider.md#baseprovider)
+
+#### Constructors
+
+##### Constructor
+
+> **new OrderSearchProvider**(`cache`, `context`): [`OrderSearchProvider`](#ordersearchprovider)
+
+Defined in: [base.provider.ts:13](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L13)
+
+###### Parameters
+
+###### cache
+
+`Cache`
+
+###### context
+
+`RequestContext`
+
+###### Returns
+
+[`OrderSearchProvider`](#ordersearchprovider)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`constructor`](base.provider.md#constructor)
+
+#### Properties
+
+##### cache
+
+> `protected` **cache**: `Cache`
+
+Defined in: [base.provider.ts:10](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L10)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`cache`](base.provider.md#cache)
+
+##### context
+
+> `protected` **context**: `RequestContext`
+
+Defined in: [base.provider.ts:11](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L11)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`context`](base.provider.md#context)
+
+#### Methods
+
+##### generateCacheKeyForQuery()
+
+> `protected` **generateCacheKeyForQuery**(`scope`, `query`): `string`
+
+Defined in: [base.provider.ts:32](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L32)
+
+###### Parameters
+
+###### scope
+
+`string`
+
+###### query
+
+`object`
+
+###### Returns
+
+`string`
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateCacheKeyForQuery`](base.provider.md#generatecachekeyforquery)
+
+##### generateDependencyIdsForModel()
+
+> **generateDependencyIdsForModel**(`model`): `string`[]
+
+Defined in: [base.provider.ts:18](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L18)
+
+###### Parameters
+
+###### model
+
+`unknown`
+
+###### Returns
+
+`string`[]
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateDependencyIdsForModel`](base.provider.md#generatedependencyidsformodel)
+
+##### getResourceName()
+
+> `protected` **getResourceName**(): `string`
+
+Defined in: [order-search.provider.ts:13](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/order-search.provider.ts#L13)
+
+Returns the abstract resource name provided by the remote system.
+
+###### Returns
+
+`string`
+
+###### Overrides
+
+[`BaseProvider`](base.provider.md#baseprovider).[`getResourceName`](base.provider.md#getresourcename)
+
+##### queryByTerm()
+
+> `abstract` **queryByTerm**(`payload`): `Promise`\<`Result`\<`OrderSearchResult`\>\>
+
+Defined in: [order-search.provider.ts:24](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/order-search.provider.ts#L24)
+
+Queries orders based on the provided search criteria.
+
+Usecase: A customer is in the My Account section, and wants to search for orders placed within the last month that are marked as "shipped".
+Usecase: A widget on the frontpage after login, shows the last 5 orders placed by the customer.
+
+###### Parameters
+
+###### payload
+
+`OrderSearchQueryByTerm`
+
+The search criteria for querying orders.
+
+###### Returns
+
+`Promise`\<`Result`\<`OrderSearchResult`\>\>

package/documentation/docs/providers/order.provider.md

@@ -0,0 +1,160 @@
+[**@reactionary/core**](README.md)
+
+***
+
+[@reactionary/core](README.md) / order.provider
+
+# order.provider
+
+## Classes
+
+### `abstract` OrderProvider
+
+Defined in: [order.provider.ts:7](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/order.provider.ts#L7)
+
+Base capability provider, responsible for mutations (changes) and queries (fetches)
+for a given business object domain.
+
+#### Extends
+
+- [`BaseProvider`](base.provider.md#baseprovider)
+
+#### Constructors
+
+##### Constructor
+
+> **new OrderProvider**(`cache`, `context`): [`OrderProvider`](#orderprovider)
+
+Defined in: [base.provider.ts:13](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L13)
+
+###### Parameters
+
+###### cache
+
+`Cache`
+
+###### context
+
+`RequestContext`
+
+###### Returns
+
+[`OrderProvider`](#orderprovider)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`constructor`](base.provider.md#constructor)
+
+#### Properties
+
+##### cache
+
+> `protected` **cache**: `Cache`
+
+Defined in: [base.provider.ts:10](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L10)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`cache`](base.provider.md#cache)
+
+##### context
+
+> `protected` **context**: `RequestContext`
+
+Defined in: [base.provider.ts:11](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L11)
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`context`](base.provider.md#context)
+
+#### Methods
+
+##### createEmptyOrder()
+
+> `protected` **createEmptyOrder**(): `Order`
+
+Defined in: [order.provider.ts:17](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/order.provider.ts#L17)
+
+###### Returns
+
+`Order`
+
+##### generateCacheKeyForQuery()
+
+> `protected` **generateCacheKeyForQuery**(`scope`, `query`): `string`
+
+Defined in: [base.provider.ts:32](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L32)
+
+###### Parameters
+
+###### scope
+
+`string`
+
+###### query
+
+`object`
+
+###### Returns
+
+`string`
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateCacheKeyForQuery`](base.provider.md#generatecachekeyforquery)
+
+##### generateDependencyIdsForModel()
+
+> **generateDependencyIdsForModel**(`model`): `string`[]
+
+Defined in: [base.provider.ts:18](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/base.provider.ts#L18)
+
+###### Parameters
+
+###### model
+
+`unknown`
+
+###### Returns
+
+`string`[]
+
+###### Inherited from
+
+[`BaseProvider`](base.provider.md#baseprovider).[`generateDependencyIdsForModel`](base.provider.md#generatedependencyidsformodel)
+
+##### getById()
+
+> `abstract` **getById**(`payload`): `Promise`\<`Result`\<`Order`, `NotFoundError`\>\>
+
+Defined in: [order.provider.ts:15](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/order.provider.ts#L15)
+
+Get order by ID.
+
+Usecase: Fetch order after checkout, to check if we are fully paid and can continue to order confirmation page.
+
+###### Parameters
+
+###### payload
+
+`OrderQueryById`
+
+###### Returns
+
+`Promise`\<`Result`\<`Order`, `NotFoundError`\>\>
+
+##### getResourceName()
+
+> `protected` **getResourceName**(): `string`
+
+Defined in: [order.provider.ts:60](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/order.provider.ts#L60)
+
+Returns the abstract resource name provided by the remote system.
+
+###### Returns
+
+`string`
+
+###### Overrides
+
+[`BaseProvider`](base.provider.md#baseprovider).[`getResourceName`](base.provider.md#getresourcename)