fix(composables): adding promotion code (#1099)

shopware · Jul 18, 2024 · 3bde5fe · 3bde5fe
1 parent 8b49869
commit 3bde5fe
Show file tree

Hide file tree

Showing 13 changed files with 216 additions and 92 deletions.
diff --git a/.changeset/twenty-drinks-end.md b/.changeset/twenty-drinks-end.md
@@ -0,0 +1,5 @@
+---
+"@shopware-pwa/composables-next": patch
+---
+
+`useCart` - Fixed adding promotion code
diff --git a/examples/adyen-dropin-component/api-types/storeApiTypes.d.ts b/examples/adyen-dropin-component/api-types/storeApiTypes.d.ts
@@ -7400,13 +7400,22 @@ export type operations = {
       "sw-language-id"?: string;
     };
     body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
+      items: (
+        | {
+            id: string;
+            quantity: number;
+            referencedId?: string;
+            /** @enum {string} */
+            type: "product" | "custom" | "credit" | "discount" | "container";
+          }
+        | {
+            id?: string;
+            quantity?: number;
+            referencedId: string;
+            /** @enum {string} */
+            type: "promotion";
+          }
+      )[];
     };
     response: components["schemas"]["Cart"];
     responseCode: 200;

diff --git a/examples/b2b-quote-management/api-types/storeApiTypes.d.ts b/examples/b2b-quote-management/api-types/storeApiTypes.d.ts
@@ -7292,13 +7292,22 @@ export type operations = {
       "sw-language-id"?: string;
     };
     body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
+      items: (
+        | {
+            id: string;
+            quantity: number;
+            referencedId?: string;
+            /** @enum {string} */
+            type: "product" | "custom" | "credit" | "discount" | "container";
+          }
+        | {
+            id?: string;
+            quantity?: number;
+            referencedId: string;
+            /** @enum {string} */
+            type: "promotion";
+          }
+      )[];
     };
     response: components["schemas"]["Cart"];
     responseCode: 200;

diff --git a/examples/commercial-customized-products/api-types/storeApiTypes.d.ts b/examples/commercial-customized-products/api-types/storeApiTypes.d.ts
@@ -7314,13 +7314,22 @@ export type operations = {
       "sw-language-id"?: string;
     };
     body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
+      items: (
+        | {
+            id: string;
+            quantity: number;
+            referencedId?: string;
+            /** @enum {string} */
+            type: "product" | "custom" | "credit" | "discount" | "container";
+          }
+        | {
+            id?: string;
+            quantity?: number;
+            referencedId: string;
+            /** @enum {string} */
+            type: "promotion";
+          }
+      )[];
     };
     response: components["schemas"]["Cart"];
     responseCode: 200;

diff --git a/examples/commercial-quick-order/api-types/storeApiTypes.d.ts b/examples/commercial-quick-order/api-types/storeApiTypes.d.ts
@@ -7316,13 +7316,22 @@ export type operations = {
       "sw-language-id"?: string;
     };
     body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
+      items: (
+        | {
+            id: string;
+            quantity: number;
+            referencedId?: string;
+            /** @enum {string} */
+            type: "product" | "custom" | "credit" | "discount" | "container";
+          }
+        | {
+            id?: string;
+            quantity?: number;
+            referencedId: string;
+            /** @enum {string} */
+            type: "promotion";
+          }
+      )[];
     };
     response: components["schemas"]["Cart"];
     responseCode: 200;

diff --git a/examples/commercial-quick-order/src/App.vue b/examples/commercial-quick-order/src/App.vue
@@ -28,7 +28,7 @@ const successToastMessage = ref("");
 // store for received items (from API via search or file-upload action)
 const ITEMS_CACHE = ref(new Map());
 // store for locally selected items (to be added to the shopping cart later on)
-const chosenItems = ref(new Map());
+const chosenItems = ref(new Map<string, number>());
 // container for product search response
 const items = ref<Schemas["B2BProductDefinition"][]>([]);
 // indicates whether there are any items found in API
@@ -83,7 +83,7 @@ const onItemClick = (item: Schemas["B2BProductDefinition"]) => {
   if (chosenItems.value.has(item.id)) {
     chosenItems.value.set(
       item.id,
-      chosenItems.value.get(item.id) + (item.quantity || 1),
+      (chosenItems.value.get(item.id) ?? 0) + (item.quantity || 1),
     );
   } else {
     ITEMS_CACHE.value.set(item.id, item);
@@ -95,23 +95,18 @@ const onItemClick = (item: Schemas["B2BProductDefinition"]) => {
 };
 
 const onAddToCartClick = async () => {
-  const lineItemsPayload = Array.from(chosenItems.value.entries()).map(
-    ([productId, quantity]) => ({
-      referencedId: productId,
-      quantity,
+  const lineItemsPayload =
+    Array.from(chosenItems.value.entries()).map(([productId, quantity]) => ({
+      id: productId,
+      quantity: quantity ?? 0,
       type: "product",
-    }),
-  );
+    })) || null;
+
+  if (lineItemsPayload) return;
 
   await apiClient.invoke("addLineItem post /checkout/cart/line-item", {
     body: {
-      // TODO(MD): fix types in component and avoid this cast
-      items: lineItemsPayload as Array<{
-        id: string;
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit";
-      }>,
+      items: lineItemsPayload,
     },
   });
 

diff --git a/examples/express-checkout/api-types/storeApiTypes.d.ts b/examples/express-checkout/api-types/storeApiTypes.d.ts
@@ -7292,13 +7292,22 @@ export type operations = {
       "sw-language-id"?: string;
     };
     body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
+      items: (
+        | {
+            id: string;
+            quantity: number;
+            referencedId?: string;
+            /** @enum {string} */
+            type: "product" | "custom" | "credit" | "discount" | "container";
+          }
+        | {
+            id?: string;
+            quantity?: number;
+            referencedId: string;
+            /** @enum {string} */
+            type: "promotion";
+          }
+      )[];
     };
     response: components["schemas"]["Cart"];
     responseCode: 200;

diff --git a/examples/mollie-credit-card/api-types/storeApiTypes.d.ts b/examples/mollie-credit-card/api-types/storeApiTypes.d.ts
@@ -7292,13 +7292,22 @@ export type operations = {
       "sw-language-id"?: string;
     };
     body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
+      items: (
+        | {
+            id: string;
+            quantity: number;
+            referencedId?: string;
+            /** @enum {string} */
+            type: "product" | "custom" | "credit" | "discount" | "container";
+          }
+        | {
+            id?: string;
+            quantity?: number;
+            referencedId: string;
+            /** @enum {string} */
+            type: "promotion";
+          }
+      )[];
     };
     response: components["schemas"]["Cart"];
     responseCode: 200;

diff --git a/packages/api-client/api-types/storeApiSchema.overrides.json b/packages/api-client/api-types/storeApiSchema.overrides.json
@@ -643,6 +643,77 @@
         }
       ]
     },
+    "/checkout/cart/line-item": {
+      "post": [
+        {
+          "requestBody": {
+            "required": true,
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": ["items"],
+                  "properties": {
+                    "items": {
+                      "type": "array",
+                      "items": {
+                        "anyOf": [
+                          {
+                            "type": "object",
+                            "required": ["id", "type", "quantity"],
+                            "properties": {
+                              "id": {
+                                "type": "string"
+                              },
+                              "referencedId": {
+                                "type": "string"
+                              },
+                              "quantity": {
+                                "type": "number"
+                              },
+                              "type": {
+                                "type": "string",
+                                "enum": [
+                                  "product",
+                                  "custom",
+                                  "credit",
+                                  "discount",
+                                  "container"
+                                ]
+                              }
+                            }
+                          },
+                          {
+                            "type": "object",
+                            "required": ["referencedId", "type"],
+                            "properties": {
+                              "id": {
+                                "type": "string"
+                              },
+                              "referencedId": {
+                                "type": "string"
+                              },
+                              "quantity": {
+                                "type": "number"
+                              },
+                              "type": {
+                                "type": "string",
+                                "enum": ["promotion"]
+                              }
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  },
+                  "$ref": "_DELETE_"
+                }
+              }
+            }
+          }
+        }
+      ]
+    },
     "/quote/detail/{id}": {
       "post": [
         {

diff --git a/packages/api-client/api-types/storeApiTypes.d.ts b/packages/api-client/api-types/storeApiTypes.d.ts
@@ -7292,13 +7292,22 @@ export type operations = {
       "sw-language-id"?: string;
     };
     body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
+      items: (
+        | {
+            id: string;
+            quantity: number;
+            referencedId?: string;
+            /** @enum {string} */
+            type: "product" | "custom" | "credit" | "discount" | "container";
+          }
+        | {
+            id?: string;
+            quantity?: number;
+            referencedId: string;
+            /** @enum {string} */
+            type: "promotion";
+          }
+      )[];
     };
     response: components["schemas"]["Cart"];
     responseCode: 200;

diff --git a/packages/api-client/api-types/storeApiTypes.overrides.ts b/packages/api-client/api-types/storeApiTypes.overrides.ts
@@ -109,25 +109,6 @@ export type operations = {
     response: components["schemas"]["Customer"];
     responseCode: 200;
   };
-  "addLineItem post /checkout/cart/line-item": {
-    contentType?: "application/json";
-    accept?: "application/json";
-    headers?: {
-      /** Instructs Shopware to return the response in the given language. */
-      "sw-language-id"?: string;
-    };
-    body: {
-      // TODO: [OpenAPI][addLineItem] - add proper request body type with required fields
-      items: Array<{
-        id: string; // TODO: [OpenAPI][addLineItem] - check if this is used at all?
-        referencedId?: string;
-        quantity?: number;
-        type: "product" | "promotion" | "custom" | "credit"; // TODO: [OpenAPI][addLineItem] - add proper type -> see also #456
-      }>;
-    };
-    response: components["schemas"]["Cart"];
-    responseCode: 200;
-  };
   "updateLineItem patch /checkout/cart/line-item": {
     contentType?: "application/json";
     accept?: "application/json";

diff --git a/packages/composables/src/useCart.ts b/packages/composables/src/useCart.ts
@@ -120,7 +120,7 @@ export function useCartFunction(): UseCartReturn {
     return addProducts([
       {
         id: params.id,
-        quantity: params.quantity,
+        quantity: params.quantity ?? 0,
         type: "product",
       },
     ]);
@@ -190,7 +190,7 @@ export function useCartFunction(): UseCartReturn {
         body: {
           items: [
             {
-              id: promotionCode,
+              referencedId: promotionCode,
               type: "promotion",
             },
           ],