@reactionary/source 0.3.0 → 0.3.1

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

@@ -0,0 +1,244 @@
+[**@reactionary/core**](README.md)
+
+***
+
+[@reactionary/core](README.md) / category.provider
+
+# category.provider
+
+## Foo
+
+### `abstract` CategoryProvider
+
+Defined in: [category.provider.ts:16](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/category.provider.ts#L16)
+
+CategoryProvider
+
+This provider allows fetching of single or sets of categories.
+
+We only allow fetching one hierachy level at a time, for now. This is to avoid development patterns of "fetch 5000 categories in one go.."
+
+#### Extends
+
+- [`BaseProvider`](base.provider.md#baseprovider)
+
+#### Constructors
+
+##### Constructor
+
+> **new CategoryProvider**(`cache`, `context`): [`CategoryProvider`](#categoryprovider)
+
+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
+
+[`CategoryProvider`](#categoryprovider)
+
+###### 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
+
+##### findChildCategories()
+
+> `abstract` **findChildCategories**(`payload`): `Promise`\<`Result`\<`CategoryPaginatedResult`\>\>
+
+Defined in: [category.provider.ts:66](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/category.provider.ts#L66)
+
+Finds all child categories of a given category.
+
+Usecase: You are rendering a top menu, or mega menu, and you need the show the child categories of a given category.
+
+NOTE: it is recommended to create a navigational service, that allows combining CMS and Static pages into this, rather than fetching categories directly.
+
+###### Parameters
+
+###### payload
+
+`CategoryQueryForChildCategories`
+
+###### Returns
+
+`Promise`\<`Result`\<`CategoryPaginatedResult`\>\>
+
+##### findTopCategories()
+
+> `abstract` **findTopCategories**(`payload`): `Promise`\<`Result`\<`CategoryPaginatedResult`\>\>
+
+Defined in: [category.provider.ts:75](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/category.provider.ts#L75)
+
+Returns all top categories, i.e. categories without a parent.
+
+Usecase: You are rendering a top menu, or mega menu, and you need the show the top level categories.
+
+###### Parameters
+
+###### payload
+
+`CategoryQueryForTopCategories`
+
+###### Returns
+
+`Promise`\<`Result`\<`CategoryPaginatedResult`\>\>
+
+##### 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)
+
+##### getBreadcrumbPathToCategory()
+
+> `abstract` **getBreadcrumbPathToCategory**(`payload`): `Promise`\<`Result`\<`Category`[]\>\>
+
+Defined in: [category.provider.ts:51](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/category.provider.ts#L51)
+
+Gets the breadcrumb path to the category, i.e. all parents up to the root.
+The returned order is from root to leaf.
+
+Usecase: You are rendering a category or product page, and you need to show the breadcrumb path.
+
+###### Parameters
+
+###### payload
+
+`CategoryQueryForBreadcrumb`
+
+###### Returns
+
+`Promise`\<`Result`\<`Category`[]\>\>
+
+##### getById()
+
+> `abstract` **getById**(`payload`): `Promise`\<`Result`\<`Category`, `NotFoundError`\>\>
+
+Defined in: [category.provider.ts:32](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/category.provider.ts#L32)
+
+Get a single category by its ID. Cannot return null, because HOW did you come across a categories ID that does not exist?
+
+DISCUSSION: What do you persist in, say, a CMS or Recommendation engine? The seo slug or the ID?
+We have previous discussed, that the ID is not necessarily the DATABASE id, but rather an externally unique identifier for the category.
+
+So, if you persist that externally, you could actually end up with an ID that does not exist in the current system.
+
+For now, the result will be en empty category, but we should probably throw an error instead.
+
+Use case: You have received a list of category ids from a recommendation engine, and you need to show a tile of this.
+Future optimization: getByIds(ids: CategoryIdentifier[], reqCtx: RequestContext): Promise<T[]>
+
+###### Parameters
+
+###### payload
+
+`CategoryQueryById`
+
+###### Returns
+
+`Promise`\<`Result`\<`Category`, `NotFoundError`\>\>
+
+##### getBySlug()
+
+> `abstract` **getBySlug**(`payload`): `Promise`\<`Result`\<`Category`, `NotFoundError`\>\>
+
+Defined in: [category.provider.ts:41](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/category.provider.ts#L41)
+
+Gets a single category by its seo slug
+
+Usecase: You are rendering a category page, and you have the slug from the URL.
+
+###### Parameters
+
+###### payload
+
+`CategoryQueryBySlug`
+
+###### Returns
+
+`Promise`\<`Result`\<`Category`, `NotFoundError`\>\>
+
+##### getResourceName()
+
+> `protected` **getResourceName**(): `string`
+
+Defined in: [category.provider.ts:78](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/category.provider.ts#L78)
+
+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/checkout.provider.md

@@ -0,0 +1,315 @@
+[**@reactionary/core**](README.md)
+
+***
+
+[@reactionary/core](README.md) / checkout.provider
+
+# checkout.provider
+
+## Classes
+
+### `abstract` CheckoutProvider
+
+Defined in: [checkout.provider.ts:8](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.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 CheckoutProvider**(`cache`, `context`): [`CheckoutProvider`](#checkoutprovider)
+
+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
+
+[`CheckoutProvider`](#checkoutprovider)
+
+###### 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
+
+##### addPaymentInstruction()
+
+> `abstract` **addPaymentInstruction**(`payload`): `Promise`\<`Result`\<`Checkout`\>\>
+
+Defined in: [checkout.provider.ts:68](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L68)
+
+Adds a payment instruction to the checkout. This will typically create a payment intent in the payment provider, and return whatever is needed to continue the payment process, e.g. a client secret for Stripe, or a redirect URL for PayPal.
+
+Usecase: User has chosen a payment method, and you need to start the payment process.
+
+###### Parameters
+
+###### payload
+
+`CheckoutMutationAddPaymentInstruction`
+
+###### Returns
+
+`Promise`\<`Result`\<`Checkout`\>\>
+
+##### finalizeCheckout()
+
+> `abstract` **finalizeCheckout**(`payload`): `Promise`\<`Result`\<`Checkout`\>\>
+
+Defined in: [checkout.provider.ts:100](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L100)
+
+Finalizes the checkout process. This typically involves creating an order from the checkout and processing payment.
+
+Usecase: User has completed all necessary steps in the checkout process and is ready to place the order.
+
+###### Parameters
+
+###### payload
+
+`CheckoutMutationFinalizeCheckout`
+
+###### Returns
+
+`Promise`\<`Result`\<`Checkout`\>\>
+
+##### 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)
+
+##### getAvailablePaymentMethods()
+
+> `abstract` **getAvailablePaymentMethods**(`payload`): `Promise`\<`Result`\<`PaymentMethod`[]\>\>
+
+Defined in: [checkout.provider.ts:60](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L60)
+
+Returns all available payment methods for the given checkout. This will typically depend mostly on the billing address and jurisdiction.
+
+Usecase: User has chosen shipping method, and you need to show available payment methods.
+
+###### Parameters
+
+###### payload
+
+`CheckoutQueryForAvailablePaymentMethods`
+
+###### Returns
+
+`Promise`\<`Result`\<`PaymentMethod`[]\>\>
+
+##### getAvailableShippingMethods()
+
+> `abstract` **getAvailableShippingMethods**(`payload`): `Promise`\<`Result`\<`ShippingMethod`[]\>\>
+
+Defined in: [checkout.provider.ts:50](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L50)
+
+Returns all available shipping methods for the given checkout. This will typically depend on the shipping address, and possibly also the items in the checkout.
+
+Usecase: User has filled out shipping address, and you need to show available shipping methods.
+
+###### Parameters
+
+###### payload
+
+`CheckoutQueryForAvailableShippingMethods`
+
+###### Returns
+
+`Promise`\<`Result`\<`ShippingMethod`[]\>\>
+
+##### getById()
+
+> `abstract` **getById**(`payload`): `Promise`\<`Result`\<`Checkout`, `NotFoundError`\>\>
+
+Defined in: [checkout.provider.ts:30](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L30)
+
+Fetches an existing checkout by its identifier.
+
+Usecase: User has navigated to the checkout page, or reloaded on it , or has been redirected back from the payment provider.
+
+###### Parameters
+
+###### payload
+
+`CheckoutQueryById`
+
+###### Returns
+
+`Promise`\<`Result`\<`Checkout`, `NotFoundError`\>\>
+
+##### getResourceName()
+
+> **getResourceName**(): `string`
+
+Defined in: [checkout.provider.ts:103](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L103)
+
+Returns the abstract resource name provided by the remote system.
+
+###### Returns
+
+`string`
+
+###### Overrides
+
+[`BaseProvider`](base.provider.md#baseprovider).[`getResourceName`](base.provider.md#getresourcename)
+
+##### initiateCheckoutForCart()
+
+> `abstract` **initiateCheckoutForCart**(`payload`): `Promise`\<`Result`\<`Checkout`\>\>
+
+Defined in: [checkout.provider.ts:20](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L20)
+
+This starts a new checkout session for the given cart. The checkout might duplicate the cart, or just reference it, depending on implementation, but changes to the cart,
+is not reflected in the checkout, and vice versa. The checkout is a snapshot of the cart at the time of initiation.
+The checkout will typically copy over addresses from the user profile, if available, or from the anonymous profile in the session.
+
+Usecase: User has filled out cart, and is ready to checkout. You call this to create a checkout object, that you can then use to set shipping method, payment method etc.
+
+###### Parameters
+
+###### payload
+
+`CheckoutMutationInitiateCheckout`
+
+###### Returns
+
+`Promise`\<`Result`\<`Checkout`\>\>
+
+##### removePaymentInstruction()
+
+> `abstract` **removePaymentInstruction**(`payload`): `Promise`\<`Result`\<`Checkout`\>\>
+
+Defined in: [checkout.provider.ts:76](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L76)
+
+Removes a payment instruction from the checkout. This will typically void the payment intent in the payment provider, and remove the payment instruction from the checkout.
+
+Usecase: User has decided to change payment method, or has cancelled the payment process.
+
+###### Parameters
+
+###### payload
+
+`CheckoutMutationRemovePaymentInstruction`
+
+###### Returns
+
+`Promise`\<`Result`\<`Checkout`\>\>
+
+##### setShippingAddress()
+
+> `abstract` **setShippingAddress**(`payload`): `Promise`\<`Result`\<`Checkout`\>\>
+
+Defined in: [checkout.provider.ts:40](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L40)
+
+Updates the shipping address for the checkout and recalculates the shipping methods and totals.
+
+Usecase: User has chosen home delivery and you have allowed them to change the address on the checkout page.
+
+NOTE: Unsure this is really needed.
+
+###### Parameters
+
+###### payload
+
+`CheckoutMutationSetShippingAddress`
+
+###### Returns
+
+`Promise`\<`Result`\<`Checkout`\>\>
+
+##### setShippingInstruction()
+
+> `abstract` **setShippingInstruction**(`payload`): `Promise`\<`Result`\<`Checkout`\>\>
+
+Defined in: [checkout.provider.ts:90](https://github.com/Solteq/reactionary/blob/ca9304f3dfc56eb7283e5bdf90b26f13d42dce7d/core/src/providers/checkout.provider.ts#L90)
+
+Sets the shipping method and optional pickup point for the checkout. The pickup point can be a physical store, a locker, or similar.
+If it is unset, it means home delivery to the shipping address.
+
+Usecase: record all the users shipping choices, and any special instructions they may have added.
+
+###### Parameters
+
+###### payload
+
+`CheckoutMutationSetShippingInstruction`
+
+###### Returns
+
+`Promise`\<`Result`\<`Checkout`\>\>