@ikas/storefront 1.0.21 → 2.0.0-alpha.1

package/src/api/checkout/index.ts

@@ -0,0 +1,884 @@
+import gql from "graphql-tag";
+import { apollo } from "../apollo";
+import {
+  IkasCheckout,
+  IkasPaymentMethodDetail,
+  IkasInstallmentInfo,
+  IkasInstallmentInfoInput,
+  IkasOrder,
+} from "../../models";
+import * as GetCheckoutByCartIdTypes from "./__generated__/getCheckoutByCartId";
+import * as GetCheckoutByIdTypes from "./__generated__/getCheckoutById";
+import * as SaleTransactionTypes from "./__generated__/createSaleTransactionWithCheckout";
+import * as ListPaymentGatewayTypes from "./__generated__/listPaymentGateway";
+import * as CheckStocksTypes from "./__generated__/checkStocks";
+import * as SaveCheckoutTypes from "./__generated__/saveCheckout";
+import * as RetrieveInstallmentInfoTypes from "./__generated__/retrieveInstallmentInfo";
+import * as ListCheckoutSettingsTypes from "./__generated__/listCheckoutSettings";
+import * as GetOrderTypes from "./__generated__/getOrder";
+import * as AddCouponTypes from "./__generated__/addCouponCodeToCheckout";
+import { IkasPaymentGateway } from "../../models/data/payment-gateway";
+import { IkasStorefrontConfig } from "../../storefront";
+import { IkasCheckoutSettings } from "../../models/data/checkout-settings";
+import { GraphQLError } from "graphql";
+
+export class IkasCheckoutAPI {
+  static async getCheckoutId(cartId: string): Promise<string | undefined> {
+    const QUERY = gql`
+      query getCheckoutByCartId($cartId: String!) {
+        getCheckoutByCartId(cartId: $cartId) {
+          id
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .query<
+          GetCheckoutByCartIdTypes.getCheckoutByCartId,
+          GetCheckoutByCartIdTypes.getCheckoutByCartIdVariables
+        >({
+          query: QUERY,
+          variables: {
+            cartId,
+          },
+        });
+
+      if (errors && errors.length) {
+        console.log(errors);
+      }
+
+      if (data) return data.getCheckoutByCartId.id!;
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  static async getCheckoutById(id: string): Promise<IkasCheckout | undefined> {
+    const QUERY = gql`
+      query getCheckoutById($id: String!) {
+        getCheckoutById(id: $id) {
+          totalFinalPrice
+          note
+          availableShippingMethods {
+            price
+            rateName
+            shippingMethod
+            shippingSettingsId
+            shippingZoneRateId
+          }
+          billingAddress {
+            id
+            addressLine1
+            addressLine2
+            city {
+              code
+              id
+              name
+            }
+            company
+            country {
+              code
+              id
+              name
+              iso2
+              iso3
+            }
+            district {
+              code
+              id
+              name
+            }
+            firstName
+            identityNumber
+            isDefault
+            lastName
+            phone
+            postalCode
+            state {
+              code
+              id
+              name
+            }
+            taxNumber
+            taxOffice
+          }
+          cartId
+          couponCode
+          createdAt
+          customer {
+            email
+            firstName
+            id
+            lastName
+            notificationsAccepted
+          }
+          deleted
+          id
+          merchantId
+          orderId
+          orderNumber
+          recoverEmailStatus
+          recoveryStatus
+          shippingAddress {
+            id
+            addressLine1
+            addressLine2
+            city {
+              code
+              id
+              name
+            }
+            company
+            country {
+              id
+              code
+              name
+              iso2
+              iso3
+            }
+            district {
+              name
+              id
+              code
+            }
+            firstName
+            identityNumber
+            isDefault
+            lastName
+            phone
+            postalCode
+            state {
+              name
+              id
+              code
+            }
+            taxNumber
+            taxOffice
+          }
+          shippingLines {
+            title
+            taxValue
+            price
+            shippingSettingsId
+            shippingZoneRateId
+          }
+          shippingMethod
+          shippingSettingsId
+          shippingZoneRateId
+          status
+          updatedAt
+          cart {
+            createdAt
+            currencyCode
+            customerId
+            dueDate
+            id
+            itemCount
+            taxLines {
+              price
+              rate
+            }
+            items {
+              createdAt
+              currencyCode
+              discount {
+                amount
+                amountType
+                reason
+              }
+              discountPrice
+              finalPrice
+              id
+              originalOrderLineItemId
+              price
+              quantity
+              status
+              deleted
+              statusUpdatedAt
+              stockLocationId
+              taxValue
+              updatedAt
+              variant {
+                barcodeList
+                id
+                mainImageId
+                name
+                productId
+                sku
+                slug
+                variantValues {
+                  order
+                  variantTypeId
+                  variantTypeName
+                  variantValueId
+                  variantValueName
+                }
+              }
+              options {
+                name
+                productOptionId
+                productOptionsSetId
+                type
+                values {
+                  name
+                  price
+                  value
+                }
+              }
+            }
+            merchantId
+            status
+            totalPrice
+            updatedAt
+          }
+          adjustments {
+            amount
+            amountType
+            name
+            order
+            type
+            couponId
+            appliedOrderLines {
+              amount
+              appliedQuantity
+              orderLineId
+            }
+          }
+          giftPackageLines {
+            price
+            taxValue
+          }
+          isGiftPackage
+          giftPackageNote
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .query<
+          GetCheckoutByIdTypes.getCheckoutById,
+          GetCheckoutByIdTypes.getCheckoutByIdVariables
+        >({
+          query: QUERY,
+          variables: {
+            id,
+          },
+        });
+
+      if (errors && errors.length) {
+        console.log(errors);
+      }
+
+      if (data)
+        return new IkasCheckout(
+          (data.getCheckoutById as unknown) as IkasCheckout
+        );
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  static async getOrder(orderId: string): Promise<IkasOrder | undefined> {
+    const QUERY = gql`
+      query getOrder($orderId: String!) {
+        getOrder(orderId: $orderId) {
+          billingAddress {
+            addressLine1
+            addressLine2
+            city {
+              code
+              id
+              name
+            }
+            company
+            country {
+              name
+              id
+              code
+            }
+            district {
+              name
+              id
+              code
+            }
+            firstName
+            identityNumber
+            isDefault
+            lastName
+            phone
+            postalCode
+            state {
+              name
+              id
+              code
+            }
+            taxNumber
+            taxOffice
+          }
+          cancelledAt
+          cancelReason
+          createdAt
+          currencyCode
+          currencyRates {
+            rate
+            originalRate
+            code
+          }
+          customer {
+            lastName
+            firstName
+            email
+            id
+          }
+          deleted
+          id
+          merchantId
+          note
+          orderedAt
+          orderAdjustments {
+            type
+            order
+            name
+            amountType
+            amount
+          }
+          orderLineItems {
+            createdAt
+            currencyCode
+            deleted
+            discount {
+              reason
+              amountType
+              amount
+            }
+            discountPrice
+            finalPrice
+            id
+            originalOrderLineItemId
+            price
+            quantity
+            status
+            statusUpdatedAt
+            stockLocationId
+            taxValue
+            updatedAt
+            variant {
+              barcodeList
+              id
+              mainImageId
+              name
+              productId
+              sku
+              variantValues {
+                variantValueName
+                variantValueId
+                variantTypeName
+                variantTypeId
+                order
+              }
+            }
+            options {
+              name
+              productOptionId
+              productOptionsSetId
+              type
+              values {
+                name
+                price
+                value
+              }
+            }
+          }
+          orderNumber
+          orderPackages {
+            updatedAt
+            trackingInfo {
+              trackingNumber
+              trackingLink
+              isSendNotification
+              cargoCompany
+            }
+            stockLocationId
+            orderPackageNumber
+            orderPackageFulfillStatus
+            orderLineItemIds
+            id
+            deleted
+            createdAt
+          }
+          orderPackageStatus
+          orderPaymentStatus
+          orderTagIds
+          shippingAddress {
+            taxOffice
+            taxNumber
+            state {
+              name
+              id
+              code
+            }
+            postalCode
+            phone
+            lastName
+            isDefault
+            identityNumber
+            firstName
+            district {
+              name
+              id
+              code
+            }
+            country {
+              name
+              id
+              code
+            }
+            company
+            city {
+              id
+              code
+              name
+            }
+            addressLine2
+            addressLine1
+          }
+          shippingLines {
+            title
+            taxValue
+            price
+          }
+          shippingMethod
+          status
+          taxLines {
+            rate
+            price
+          }
+          totalFinalPrice
+          totalPrice
+          updatedAt
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .query<GetOrderTypes.getOrder, GetOrderTypes.getOrderVariables>({
+          query: QUERY,
+          variables: {
+            orderId: orderId,
+          },
+        });
+
+      if (data && data.getOrder) return new IkasOrder(data.getOrder as any);
+    } catch (err) {}
+  }
+
+  static async saveCheckout(
+    checkout: IkasCheckout
+  ): Promise<SaveCheckoutResponse | undefined> {
+    const MUTATION = gql`
+      mutation saveCheckout($input: SaveCheckoutInput!) {
+        saveCheckout(input: $input) {
+          id
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .mutate<
+          SaveCheckoutTypes.saveCheckout,
+          SaveCheckoutTypes.saveCheckoutVariables
+        >({
+          mutation: MUTATION,
+          variables: {
+            input: {
+              id: checkout.id,
+              cartId: checkout.cartId!,
+              shippingMethod: checkout.shippingMethod as any,
+              shippingSettingsId: checkout.shippingSettingsId,
+              shippingZoneRateId: checkout.shippingZoneRateId,
+              billingAddress:
+                checkout.billingAddress && checkout.billingAddress.addressLine1
+                  ? {
+                      id: checkout.billingAddress.id,
+                      addressLine1: checkout.billingAddress.addressLine1 || "",
+                      addressLine2:
+                        checkout.billingAddress.addressLine2 || null,
+                      city: checkout.billingAddress.city! as any,
+                      country: checkout.billingAddress.country! as any,
+                      state: checkout.billingAddress.state! as any,
+                      district: checkout.billingAddress.district || null,
+                      firstName: checkout.billingAddress.firstName!,
+                      lastName: checkout.billingAddress.lastName!,
+                      postalCode: checkout.billingAddress.postalCode!,
+                      company: checkout.billingAddress.company || null,
+                      phone: checkout.billingAddress.phone || null,
+                      taxNumber: checkout.billingAddress.taxNumber || null,
+                      taxOffice: checkout.billingAddress.taxOffice || null,
+                      isDefault: checkout.billingAddress.isDefault || false,
+                      identityNumber:
+                        checkout.billingAddress.identityNumber || null,
+                    }
+                  : null,
+              shippingAddress:
+                checkout.shippingAddress &&
+                checkout.shippingAddress.addressLine1
+                  ? {
+                      id: checkout.shippingAddress.id,
+                      addressLine1: checkout.shippingAddress.addressLine1 || "",
+                      addressLine2:
+                        checkout.shippingAddress.addressLine2 || null,
+                      city: checkout.shippingAddress.city! as any,
+                      country: checkout.shippingAddress.country! as any,
+                      state: checkout.shippingAddress.state! as any,
+                      district: checkout.shippingAddress.district || null,
+                      firstName: checkout.shippingAddress.firstName!,
+                      lastName: checkout.shippingAddress.lastName!,
+                      postalCode: checkout.shippingAddress.postalCode!,
+                      company: checkout.shippingAddress.company || null,
+                      phone: checkout.shippingAddress.phone || null,
+                      taxNumber: checkout.shippingAddress.taxNumber || null,
+                      taxOffice: checkout.shippingAddress.taxOffice || null,
+                      isDefault: checkout.shippingAddress.isDefault || false,
+                      identityNumber:
+                        checkout.shippingAddress.identityNumber || null,
+                    }
+                  : null,
+              couponCode: checkout.couponCode || null,
+              customer: checkout.customer
+                ? {
+                    id: checkout.customer?.id,
+                    email: checkout.customer?.email,
+                    firstName: checkout.customer?.firstName,
+                    lastName: checkout.customer?.lastName,
+                    notificationsAccepted:
+                      checkout.customer.notificationsAccepted || false,
+                  }
+                : null,
+              note: checkout.note,
+              isGiftPackage: checkout.isGiftPackage,
+              giftPackageNote: checkout.giftPackageNote,
+            },
+          },
+        });
+
+      return {
+        data: data?.saveCheckout.id || undefined,
+        errors,
+      };
+    } catch (err) {
+      console.log(err);
+      if (err && (err as any).graphQLErrors) {
+        return {
+          data: undefined,
+          errors: (err as any).graphQLErrors as any,
+        };
+      }
+    }
+  }
+
+  static async createSaleTransactionWithCheckout(
+    checkoutId: string,
+    paymentGatewayId: string,
+    paymentMethodDetail?: IkasPaymentMethodDetail
+  ) {
+    const MUTATION = gql`
+      mutation createSaleTransactionWithCheckout(
+        $input: CreateSaleTransactionWithCheckoutInput!
+      ) {
+        createSaleTransactionWithCheckout(input: $input) {
+          orderId
+          orderNumber
+          transactionId
+          transactionStatus
+          returnSlug
+          error {
+            code
+            declineCode
+            message
+          }
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .mutate<
+          SaleTransactionTypes.createSaleTransactionWithCheckout,
+          SaleTransactionTypes.createSaleTransactionWithCheckoutVariables
+        >({
+          mutation: MUTATION,
+          variables: {
+            input: {
+              checkoutId,
+              paymentGatewayId,
+              paymentMethodDetail,
+            },
+          },
+        });
+
+      if (errors && errors.length) {
+        return;
+      }
+
+      if (data) return data.createSaleTransactionWithCheckout;
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  static async listPaymentGateway(idList?: string[]) {
+    const QUERY = gql`
+      query listPaymentGateway($id: StringFilterInput, $locale: String) {
+        listPaymentGateway(id: $id, locale: $locale) {
+          paymentMethods {
+            name
+            logoUrl
+          }
+          paymentMethodType
+          id
+          name
+          description
+          testMode
+          code
+          type
+          logoUrl
+          additionalPrices {
+            amount
+            amountType
+            name
+            type
+          }
+          translations {
+            description
+            locale
+            name
+          }
+          supportedCurrencies
+          availableCountries
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .query<
+          ListPaymentGatewayTypes.listPaymentGateway,
+          ListPaymentGatewayTypes.listPaymentGatewayVariables
+        >({
+          query: QUERY,
+          variables: {
+            id: idList ? { in: idList } : undefined,
+            locale: IkasStorefrontConfig.getCurrentLocale(),
+          },
+        });
+
+      if (errors && errors.length) {
+        console.log(errors);
+      }
+
+      if (data)
+        return (data.listPaymentGateway as any).map(
+          (pg: any) => new IkasPaymentGateway(pg)
+        ) as IkasPaymentGateway[];
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  static async retrieveInstallmentInfo(input: IkasInstallmentInfoInput) {
+    const MUTATION = gql`
+      mutation retrieveInstallmentInfo($input: RetrieveInstallmentInfoInput!) {
+        retrieveInstallmentInfo(input: $input) {
+          bankName
+          binNumber
+          cardAssociation
+          cardFamily
+          cardType
+          installmentPrices {
+            totalPrice
+            installmentPrice
+            installmentCount
+          }
+          price
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .mutate<
+          RetrieveInstallmentInfoTypes.retrieveInstallmentInfo,
+          RetrieveInstallmentInfoTypes.retrieveInstallmentInfoVariables
+        >({
+          mutation: MUTATION,
+          variables: {
+            input,
+          },
+        });
+
+      if (errors && errors.length) {
+        console.log(errors);
+      }
+
+      if (data)
+        return (data.retrieveInstallmentInfo as unknown) as IkasInstallmentInfo;
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  static async checkStocks(
+    lines: CheckStocksLineInput[],
+    stockLocationIdList: string[]
+  ) {
+    const QUERY = gql`
+      query checkStocks(
+        $lines: [CheckStocksLineInput!]!
+        $stockLocationIdList: [String!]
+      ) {
+        checkStocks(lines: $lines, stockLocationIdList: $stockLocationIdList) {
+          lines {
+            stockCount
+            isAvailable
+            variantId
+          }
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .query<
+          CheckStocksTypes.checkStocks,
+          CheckStocksTypes.checkStocksVariables
+        >({
+          query: QUERY,
+          variables: {
+            lines,
+            stockLocationIdList: stockLocationIdList.length
+              ? stockLocationIdList
+              : null,
+          },
+        });
+
+      if (errors && errors.length) {
+        console.log(errors);
+      }
+
+      if (data) return data.checkStocks;
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  static async listCheckoutSettings() {
+    const QUERY = gql`
+      query listCheckoutSettings($storefrontId: StringFilterInput!) {
+        listCheckoutSettings(storefrontId: $storefrontId) {
+          createdAt
+          id
+          identityNumberRequirement
+          isAccountRequired
+          isTermsAndConditionsDefaultChecked
+          options {
+            name
+            required
+          }
+          phoneRequirement
+          showCheckoutNote
+          showTermsAndConditionsCheckbox
+          storefrontId
+          updatedAt
+          isGiftPackageEnabled
+          giftPackagePriceList {
+            currencyCode
+            price
+          }
+          isShowPostalCode
+        }
+      }
+    `;
+
+    try {
+      const { data, errors } = await apollo
+        .getClient()
+        .query<
+          ListCheckoutSettingsTypes.listCheckoutSettings,
+          ListCheckoutSettingsTypes.listCheckoutSettingsVariables
+        >({
+          query: QUERY,
+          variables: {
+            storefrontId: { eq: IkasStorefrontConfig.storefrontId },
+          },
+        });
+
+      if (errors && errors.length) {
+        console.log(errors);
+      }
+
+      if (data)
+        return data.listCheckoutSettings.map(
+          (cs) => new IkasCheckoutSettings(cs as any)
+        );
+    } catch (err) {
+      console.log(err);
+    }
+  }
+
+  static async addCouponCodeToCheckout(checkoutId: string, couponCode: string) {
+    const MUTATION = gql`
+      mutation addCouponCodeToCheckout(
+        $checkoutId: String!
+        $couponCode: String!
+      ) {
+        addCouponCodeToCheckout(
+          checkoutId: $checkoutId
+          couponCode: $couponCode
+        ) {
+          id
+        }
+      }
+    `;
+
+    try {
+      const { data } = await apollo
+        .getClient()
+        .query<
+          AddCouponTypes.addCouponCodeToCheckout,
+          AddCouponTypes.addCouponCodeToCheckoutVariables
+        >({
+          query: MUTATION,
+          variables: {
+            checkoutId,
+            couponCode,
+          },
+        });
+
+      if (data && data.addCouponCodeToCheckout.id) return true;
+    } catch (err) {}
+  }
+}
+
+type CheckStocksLineInput = {
+  quantity: number;
+  stockLocationId?: string | null;
+  variantId: string;
+  productId: string;
+};
+
+type SaveCheckoutResponse = {
+  data: string | undefined;
+  errors: readonly GraphQLError[] | undefined;
+};