feat: #49 (docs) add docs

docs/.vuepress/config.js

@@ -46,6 +46,8 @@ module.exports = {
           ['/composables/use-category', 'useCategory'],
           ['/composables/use-facet', 'useFacet'],
           ['/composables/use-cart', 'useCart'],
+          ['/composables/use-billing', 'useBilling'],
+          ['/composables/use-shipping', 'useShipping'],
         ]
       },
     ]

docs/composables/use-billing.md

@@ -0,0 +1,74 @@
+# `useBilling`
+
+## Features
+
+`useBilling` composable can be used for:
+
+* Loading billing address for the current cart.
+* Saving billing address for the current cart.
+
+## API
+
+* `load` - function for fetching billing address. When invoked, it requests data from the API and populates `billing` property. This method accepts a single optional `params` object. The `params` has the following option:
+
+  * `customQuery?: CustomQuery`
+
+```ts
+type CustomQuery = {
+  getBasicProfile: string
+}
+```
+
+* `save` - function for saving billing address. This method accepts a single `saveParams` object. The `saveParams` has the following options:
+
+  * `billingDetails: CreateAddressInput`
+
+<https://www.vendure.io/docs/graphql-api/admin/input-types/#createaddressinput>
+
+  * `customQuery?: CustomQuery`
+
+```ts
+type CustomQuery = {
+  updateCart: string
+}
+```
+
+* `billing: OrderAddress` - a main data object that contains a billing address.
+
+<https://www.vendure.io/docs/graphql-api/admin/object-types/#orderaddress>
+
+* `loading: boolean` - a reactive object containing information about loading state of your `load` or `save` method.
+
+* `error: UseBillingErrors` - a reactive object containing the error message, if `load` or `save` failed for any reason.
+
+```ts
+interface UseBillingErrors {
+  load?: Error;
+  save?: Error;
+}
+```
+
+## Getters
+
+We do not provide getters for checkout and its parts.
+
+## Example
+
+```js
+import { useBilling } from '@vue-storefront/vendure';
+import { onSSR } from '@vue-storefront/core'
+
+export default {
+  setup () {
+    const { load, billing } = useBilling();
+
+    onSSR(async () => {
+      await load();
+    });
+
+    return {
+      billing
+    };
+  }
+}
+```

docs/composables/use-shipping.md

@@ -0,0 +1,74 @@
+# `useShipping`
+
+## Features
+
+`useShipping` composable can be used for:
+
+* Loading shipping address for the current cart.
+* Saving shipping address for the current cart.
+
+## API
+
+* `load` - function for fetching shipping address. When invoked, it requests data from the API and populates `shipping` property. This method accepts a single optional `params` object. The `params` has the following option:
+
+  * `customQuery?: CustomQuery`
+
+```ts
+type CustomQuery = {
+  getBasicProfile: string
+}
+```
+
+* `save` - function for saving shipping address. This method accepts a single `saveParams` object. The `saveParams` has the following options:
+
+  * `shippingDetails: CreateAddressInput`
+
+<https://www.vendure.io/docs/graphql-api/admin/input-types/#createaddressinput>
+
+* `customQuery?: CustomQuery`
+
+```ts
+type CustomQuery = {
+  updateCart: string
+}
+```
+
+* `shipping: OrderAddress` - a main data object that contains a shipping address.
+
+<https://www.vendure.io/docs/graphql-api/admin/object-types/#orderaddress>
+
+* `loading: boolean` - a reactive object containing information about loading state of your `load` or `save` method.
+
+* `error: UseShippingErrors` - a reactive object containing the error message, if `load` or `save` failed for any reason.
+
+```ts
+interface UseShippingErrors {
+  load?: Error;
+  save?: Error;
+}
+```
+
+## Getters
+
+We do not provide getters for checkout and its parts.
+
+## Example
+
+```js
+import { useShipping } from '@vue-storefront/vendure';
+import { onSSR } from '@vue-storefront/core';
+
+export default {
+  setup () {
+    const { load, shipping } = useShipping();
+
+    onSSR(async () => {
+      await load();
+    });
+
+    return {
+      shipping
+    };
+  }
+}
+```