fix(composables): product available stock information (#1551)

* fix(composables): product availableStock includes param

* fix(composables): product customFields includes param

* feat(composables): added getAvailableStock computed to useAddToCart

* fix(composables): build documentation for getAvailableStock computed

api/composables.api.md

@@ -160,6 +160,7 @@ export const INTERCEPTOR_KEYS: {
 export interface IUseAddToCart {
  addToCart: () => Promise<void>;
  error: Ref<string>;
+ getAvailableStock: Ref<number | null>;
  getStock: Ref<number | null>;
  isInCart: Ref<boolean>;
  loading: Ref<boolean>;

docs/landing/resources/api/composables.iuseaddtocart.getavailablestock.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@shopware-pwa/composables](./composables.md) &gt; [IUseAddToCart](./composables.iuseaddtocart.md) &gt; [getAvailableStock](./composables.iuseaddtocart.getavailablestock.md)
+
+## IUseAddToCart.getAvailableStock property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Returns product count in available stock
+
+<b>Signature:</b>
+
+```typescript
+getAvailableStock: Ref<number | null>;
+```

docs/landing/resources/api/composables.iuseaddtocart.md

@@ -21,6 +21,7 @@ export interface IUseAddToCart
 | --- | --- | --- |
 | [addToCart](./composables.iuseaddtocart.addtocart.md) | () =&gt; Promise&lt;void&gt; | <b><i>(BETA)</i></b> Add to cart method |
 | [error](./composables.iuseaddtocart.error.md) | Ref&lt;string&gt; | <b><i>(BETA)</i></b> Error message when adding to cart was not successful |
+| [getAvailableStock](./composables.iuseaddtocart.getavailablestock.md) | Ref&lt;number \| null&gt; | <b><i>(BETA)</i></b> Returns product count in available stock |
 | [getStock](./composables.iuseaddtocart.getstock.md) | Ref&lt;number \| null&gt; | <b><i>(BETA)</i></b> Returns product count in stock |
 | [isInCart](./composables.iuseaddtocart.isincart.md) | Ref&lt;boolean&gt; | <b><i>(BETA)</i></b> Flag if product is already in cart |
 | [loading](./composables.iuseaddtocart.loading.md) | Ref&lt;boolean&gt; | <b><i>(BETA)</i></b> Adding to cart is in progress |

packages/composables/__tests__/useAddToCart.spec.ts

@@ -66,6 +66,30 @@ describe("Composables - useAddToCart", () => {
  });
  });
 
+ describe("getAvailableStock", () => {
+ it("should return null when no product", () => {
+ const { getAvailableStock } = useAddToCart(
+ rootContextMock,
+ null as any
+ );
+ expect(getAvailableStock.value).toBeNull();
+ });
+
+ it("should return null when no product available stock", () => {
+ const { getAvailableStock } = useAddToCart(rootContextMock, {
+ availableStock: null,
+ } as any);
+ expect(getAvailableStock.value).toBeNull();
+ });
+
+ it("should return a proper product available stock", () => {
+ const { getAvailableStock } = useAddToCart(rootContextMock, {
+ availableStock: 21,
+ } as any);
+ expect(getAvailableStock.value).toEqual(21);
+ });
+ });
+
  describe("isInCart", () => {
  it("should show that product is in cart", () => {
  cartItemsMock.value = [{ referencedId: "qwe" }];

packages/composables/src/internalHelpers/defaultApiParams.json

@@ -83,6 +83,8 @@
  "manufacturer",
  "seoUrls",
  "crossSellings",
+ "availableStock",
+ "customFields",
  "stock"
  ],
  "product_media": ["media"],
@@ -222,7 +224,9 @@
  "translated",
  "media",
  "seoUrls",
- "crossSellings"
+ "crossSellings",
+ "availableStock",
+ "customFields"
  ],
  "product_media": ["media"],
  "media": ["url"],

packages/composables/src/logic/useAddToCart.ts

@@ -34,6 +34,10 @@ export interface IUseAddToCart {
  * Returns product count in stock
  */
  getStock: Ref<number | null>;
+ /**
+ * Returns product count in available stock
+ */
+ getAvailableStock: Ref<number | null>;
  /**
  * Flag if product is already in cart
  */
@@ -109,6 +113,8 @@ export const useAddToCart = (
 
  const getStock = computed(() => product && product.stock);
 
+ const getAvailableStock = computed(() => product && product.availableStock);
+
  const isInCart = computed(
  (): boolean =>
  product &&
@@ -121,6 +127,7 @@ export const useAddToCart = (
  error,
  loading,
  getStock,
+ getAvailableStock,
  isInCart,
  onAddToCart,
  };