@springmicro/cart 0.3.4 → 0.3.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@springmicro/cart",
   "private": false,
-  "version": "0.3.4",
+  "version": "0.3.5",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
     "@nanostores/persistent": "^0.10.1",
     "@nanostores/query": "^0.3.3",
     "@nanostores/react": "^0.7.2",
-    "@springmicro/utils": "0.3.4",
+    "@springmicro/utils": "0.3.5",
     "dotenv": "^16.4.5",
     "nanostores": "^0.10.3",
     "react": "^18.2.0",
@@ -49,5 +49,5 @@
     "vite-plugin-css-injected-by-js": "^3.5.1",
     "yup": "^1.4.0"
   },
-  "gitHead": "291a6da39f3801c2d7993958d252a2ffa3f4ef1e"
+  "gitHead": "1bbf206d79047e5897172fb794fc876ad6c45498"
 }

package/src/checkout/{CheckoutList.css → ReviewCartAndCalculateTaxes.css}

@@ -44,7 +44,7 @@
   flex-direction: row;
   gap: 1rem;
   align-items: center;
-  margin-left: 56px;
+  margin-left: -29px;
   margin-bottom: 1rem;
   margin-top: 2rem;
   font-size: 18px;

package/src/checkout/ReviewCartAndCalculateTaxes.tsx

@@ -0,0 +1,366 @@
+import "./ReviewCartAndCalculateTaxes.css";
+import { Box, useTheme, useMediaQuery } from "@mui/material";
+import { setOrder as cartSetOrder } from "../utils/storage";
+import { AddCard, CCFocus, CreditCardValues } from "./components/AddCard";
+import { CartList } from "./components/CartList";
+import {
+  ChangeEventHandler,
+  FocusEventHandler,
+  useEffect,
+  useState,
+} from "react";
+import {
+  expiryDateHasNotPassed,
+  formatCreditCardNumber,
+  formatCVC,
+  formatExpirationDate,
+  splitMonthYear,
+} from "@springmicro/utils/payment";
+import * as Yup from "yup";
+import {
+  allCountries,
+  allCountriesReverse,
+  getPostalCodeDefault,
+} from "@springmicro/utils/address";
+import { AddressValues } from "./components/Address";
+import { useFormik } from "formik";
+import { postCheckout } from "../utils/api";
+
+async function createOrder(cart, apiBaseUrl) {
+  // If an order has already been created and hasn't been changed, get the previous order.
+  if (cart.order && cart.order.id && cart.order.reference) {
+    const res = await fetch(
+      `${apiBaseUrl}/api/ecommerce/orders/${cart.order.id}/reference/${cart.order.reference}`
+    );
+    const order = await res.json();
+
+    const currentUrl = new URL(window.location.href);
+    currentUrl.searchParams.set("orderId", order.id);
+    currentUrl.searchParams.set("orderRef", order.reference);
+    window.history.pushState({}, "", currentUrl);
+
+    return order;
+  }
+
+  // Otherwise, create a new order.
+  const res = await fetch(apiBaseUrl + "/api/ecommerce/orders", {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+    },
+    body: JSON.stringify({
+      customer_id: 1,
+      cart_data: {
+        items: cart.items.map((li) => ({
+          ...li,
+          name: undefined,
+          image: undefined,
+        })),
+      },
+    }),
+  });
+  const order = await res.json();
+
+  if (!order) throw "Missing order";
+  cartSetOrder({ id: order.id, reference: order.reference });
+  const currentUrl = new URL(window.location.href);
+  currentUrl.searchParams.set("orderId", order.id);
+  currentUrl.searchParams.set("orderRef", order.reference);
+  window.history.pushState({}, "", currentUrl);
+
+  return order;
+}
+
+async function getTax(apiBaseUrl, taxProvider, items, v) {
+  const res = await fetch(
+    `${apiBaseUrl}/api/ecommerce/tax?tax_provider=${taxProvider ?? "dummy"}`,
+    {
+      method: "POST",
+      body: JSON.stringify({
+        cart_data: items,
+        address: {
+          country: v.country,
+          city: v.locality,
+          line1: v.street_address,
+          postal_code: v.postal_code,
+          state: v.region,
+        },
+      }),
+      headers: {
+        "Content-Type": "application/json",
+      },
+    }
+  );
+  return await res.json();
+}
+
+export default function ReviewAndCalculateTaxes({
+  subtotal,
+  discount,
+  taxState,
+  shipping,
+  statusState,
+  cart,
+  prices,
+  apiBaseUrl,
+  orderState,
+  disableProductLink,
+  disableMissingImage,
+  taxProvider,
+  setSuccessData,
+  invoiceId = undefined,
+  onPlacement = undefined,
+}) {
+  const [formDisabled, setFormDisabled] = useState(true);
+  const [formError, setFormError] = useState(undefined);
+  const theme = useTheme();
+  const stacked = useMediaQuery(theme.breakpoints.down("lg"));
+
+  const [status, setStatus] = statusState;
+  const [tax, setTax] = taxState;
+  const [order, setOrder] = orderState;
+
+  async function createOrderAndGetTaxes(values) {
+    setFormError(undefined);
+    // status === 0 when this is clicked.
+    // Creates an order and calculates tax.
+
+    Promise.all([
+      createOrder(cart, apiBaseUrl),
+      getTax(
+        apiBaseUrl,
+        taxProvider,
+        cart.items.map((i) => ({
+          amount: prices[i.price_id].unit_amount,
+          reference: i.name,
+        })),
+        values
+      ),
+    ])
+      .then(([order, taxData]) => {
+        setTax(taxData);
+        setOrder(order);
+        setStatus(1);
+      })
+      .catch(() => {
+        setFormError(true);
+      });
+  }
+
+  async function confirmOrder(values) {
+    setFormError(undefined);
+    setFormDisabled(true);
+    postCheckout(
+      apiBaseUrl,
+      order.id,
+      order.reference,
+      values,
+      "stripe",
+      invoiceId
+    )
+      .then((data) => {
+        if (data instanceof Response) {
+          setFormError(true);
+          alert(JSON.stringify(data));
+        } else {
+          // success
+          setSuccessData(data);
+          onPlacement && onPlacement();
+          // Get the current URL
+          const currentUrl = new URL(window.location.href);
+          // Set the query parameter 'showReceipt' to '1'
+          currentUrl.searchParams.set("showReceipt", "1");
+          currentUrl.searchParams.set("orderId", order.id);
+          currentUrl.searchParams.set("orderRef", order.reference);
+
+          // Update the browser's URL and history without refreshing the page
+          window.history.pushState({}, "", currentUrl);
+        }
+        setFormDisabled(false);
+      })
+      .catch(() => {
+        console.log("ERROR");
+        setFormError(true);
+      });
+  }
+
+  /**
+   *
+   * AddCard formik data
+   *
+   */
+
+  const contact = undefined;
+  const address = true;
+
+  const initialValuesBase = {
+    cvc: "",
+    expiry: "",
+    focus: "number",
+    name: contact ? `${contact.first_name} ${contact.last_name}` : "",
+    number: "",
+  } as CreditCardValues;
+  const initialCountry = "US";
+  const initialValuesAddress = {
+    country: initialCountry ?? "",
+    email: contact?.email ?? "",
+    region: "",
+    line1: "",
+    line2: "",
+    organization: contact?.organization ?? "",
+    city: "",
+    postal_code: getPostalCodeDefault(initialCountry),
+  } as AddressValues;
+
+  const initialValues: CreditCardValues & Partial<AddressValues> = address
+    ? { ...initialValuesBase, ...initialValuesAddress }
+    : initialValuesBase;
+
+  const validationSchemaBase = {
+    expiry: Yup.string()
+      // .length(7, "Expiry date must be of the format MM/YY.")
+      .test("exp-date", "Expiry date has already passed.", (string) => {
+        if (string?.length === 5) {
+          if (string.indexOf("/") !== 2) return false;
+          const [month, year] = splitMonthYear(string);
+          return expiryDateHasNotPassed(month, year);
+        } else {
+          return true;
+        }
+      })
+      .required("Expiry date is required."),
+    number: Yup.string().required("Card Number is required."),
+    name: Yup.string().required("Cardholder Name is required."),
+    cvc: Yup.string().required("CVC is required."),
+  };
+
+  const validationSchemaAddress = {
+    country: Yup.string().required("Country is required."),
+    email: Yup.string().email().required("Email is required."),
+    line1: Yup.string().required("Street Address 1 is required."),
+    city: Yup.string().required("City is required."),
+    postal_code: Yup.string().required("Postal Code is required."),
+  };
+  const formik = useFormik({
+    initialValues,
+    validationSchema: Yup.object(
+      address
+        ? {
+            ...validationSchemaBase,
+            ...validationSchemaAddress,
+          }
+        : validationSchemaBase
+    ),
+    onSubmit: async (v, helpers) => {
+      setFormDisabled(true);
+      const values = { ...v };
+      if (formDisabled) {
+        setFormDisabled(false);
+        throw new Error("Attempted to submit an invalid form.");
+      }
+
+      const submitFunc = status === 0 ? createOrderAndGetTaxes : confirmOrder;
+
+      if (submitFunc) {
+        if (address) {
+          // match backend
+          values["street_address"] = values.line2
+            ? `${values.line1}\n${values.line2}`
+            : values.line1;
+          values["locality"] = values.city;
+          delete values.line1;
+          delete values.line2;
+          delete values.city;
+          if (Object.keys(allCountriesReverse).includes(values.country)) {
+            values.country = allCountriesReverse[values.country];
+          }
+        }
+        values["card_number"] = values.number;
+        values["expiry_date"] = values.expiry;
+        delete values.focus;
+        delete values.expiry;
+        delete values.number;
+
+        // const res = await submitFunc(values);
+        submitFunc(values)
+          .then((v) => {})
+          .finally(() => {
+            setFormDisabled(false);
+          });
+      } else {
+        setFormDisabled(false);
+      }
+    },
+  });
+
+  const handleInputFocus: FocusEventHandler<HTMLInputElement> = (e) => {
+    const focusedEl = (e.target as HTMLElement).getAttribute("name") as CCFocus;
+    if (focusedEl) {
+      formik.setValues({
+        ...formik.values,
+        focus: focusedEl,
+      });
+    }
+  };
+
+  const handleInputChange: ChangeEventHandler<HTMLInputElement> = (e) => {
+    if (e.target.name === "card_number") {
+      e.target.value = formatCreditCardNumber(e.target.value);
+    } else if (e.target.name === "expiry") {
+      e.target.value = formatExpirationDate(e.target.value);
+    } else if (e.target.name === "cvc") {
+      e.target.value = formatCVC(e.target.value);
+    }
+    formik.handleChange(e);
+  };
+
+  useEffect(() => {
+    setFormDisabled(Object.keys(formik.errors).length > 0);
+  }, [formik.errors]);
+
+  return (
+    <Box
+      sx={{
+        mt: 2,
+        display: "flex",
+        flexDirection: { xs: "column", xl: "row" },
+        justifyContent: "center",
+        alignItems: { xs: undefined, xl: "flex-start" },
+        px: { xs: 32, xl: 16 },
+        "&>div": { width: { xs: undefined, xl: "50%" } },
+      }}
+    >
+      <CartList
+        {...{
+          status,
+          cart,
+          subtotal,
+          tax,
+          shipping,
+          discount,
+          prices,
+          disableMissingImage,
+          disableProductLink,
+          formik,
+          formDisabled,
+          formError,
+        }}
+      />
+      {status === 0 && (
+        <Box sx={{ flexGrow: 1 }}>
+          <AddCard
+            onSubmit={createOrderAndGetTaxes}
+            stacked={stacked}
+            formData={{
+              formik,
+              handleInputChange,
+              handleInputFocus,
+              formDisabled,
+              formError,
+            }}
+          />
+        </Box>
+      )}
+    </Box>
+  );
+}

package/src/checkout/components/AddCard.tsx

@@ -0,0 +1,267 @@
+import { useFormik, FormikProps } from "formik";
+import * as Yup from "yup";
+import React, {
+  ChangeEventHandler,
+  useEffect,
+  PropsWithChildren,
+  useState,
+} from "react";
+import {
+  AddressCityField,
+  AddressOrganizationNameField,
+  AddressCountryField,
+  AddressPostalCodeField,
+  AddressRegionField,
+  AddressStreetField,
+  AddressEmailField,
+  AddressValues,
+} from "./Address";
+import {
+  allCountries,
+  allCountriesReverse,
+  getPostalCodeDefault,
+} from "@springmicro/utils/address";
+import { Box, Button, Container, TextField, Typography } from "@mui/material";
+import Cards from "react-credit-cards-2";
+import { FocusEventHandler } from "react";
+import {
+  formatCreditCardNumber,
+  formatCVC,
+  formatExpirationDate,
+  splitMonthYear,
+  expiryDateHasNotPassed,
+} from "@springmicro/utils/payment";
+
+// moved to index.ts
+// import "react-credit-cards-2/dist/es/styles-compiled.css";
+import { StripeLogoLink } from "./ProviderLogos";
+
+export type CCFocus = "number" | "name" | "cvc" | "expiry";
+
+export type CreditCardValues = {
+  cvc: string;
+  expiry: string;
+  focus: CCFocus;
+  name: string;
+  number: string;
+};
+
+export type AddCardProps = {
+  contact?: {
+    organization?: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+  };
+  stacked?: boolean;
+  error?: string;
+  address?: boolean;
+  onSubmit?: (
+    values: CreditCardValues & Partial<AddressValues>
+  ) => Promise<any>;
+  PriceDetails?: JSX.Element;
+  formData?: {
+    formik;
+    handleInputChange;
+    handleInputFocus;
+    formDisabled;
+    formError;
+  };
+};
+
+export const AddCard = ({
+  contact,
+  error,
+  stacked = false,
+  address = true,
+  PriceDetails,
+  formData: {
+    formik,
+    handleInputChange,
+    handleInputFocus,
+    formDisabled,
+    formError,
+  },
+}: AddCardProps) => {
+  return (
+    <Container id="paymentMethodForm">
+      <form
+        onSubmit={(e) => {
+          e.preventDefault();
+          formik.handleSubmit(e);
+        }}
+      >
+        <Box
+          sx={
+            stacked
+              ? {}
+              : {
+                  display: "flex",
+                  flexDirection: { xs: "column", sm: "row" },
+                  gap: "1em",
+                }
+          }
+        >
+          <Cards
+            {...(formik.values as CreditCardValues)}
+            focused={formik.values.focus || "number"}
+          />
+
+          <div>
+            <TextField
+              sx={stacked ? { mt: 2 } : {}}
+              fullWidth
+              type="tel"
+              name="number"
+              label="Card Number"
+              required
+              onBlur={formik.handleBlur}
+              onChange={handleInputChange}
+              onFocus={handleInputFocus}
+              variant="outlined"
+              value={formik.values.number}
+              error={Boolean(formik.touched.number && formik.errors.number)}
+              helperText={formik.touched.number && formik.errors.number}
+            />
+            <TextField
+              sx={{ mt: 2 }}
+              fullWidth
+              type="text"
+              name="name"
+              label="Name on Card"
+              required
+              onBlur={formik.handleBlur}
+              onChange={handleInputChange}
+              onFocus={handleInputFocus}
+              variant="outlined"
+              value={formik.values.name}
+              error={Boolean(formik.touched.name && formik.errors.name)}
+              helperText={formik.touched.name && formik.errors.name}
+            />
+            <TextField
+              sx={{ mt: 2, width: "calc(50% - 8px)", mr: 1 }}
+              type="tel"
+              name="expiry"
+              label="Valid Thru"
+              placeholder="MM/YY"
+              inputProps={{ pattern: "[0-9]{2}/[0-9]{2}" }}
+              required
+              onBlur={formik.handleBlur}
+              onChange={handleInputChange}
+              onFocus={handleInputFocus}
+              variant="outlined"
+              value={formik.values.expiry}
+              error={Boolean(formik.touched.expiry && formik.errors.expiry)}
+              helperText={
+                (formik.touched.expiry && formik.errors.expiry) || "MM/YY"
+              }
+            />
+            <TextField
+              sx={{ mt: 2, width: "calc(50% - 8px)", ml: 1 }}
+              type="tel"
+              name="cvc"
+              label="CVC"
+              required
+              onBlur={formik.handleBlur}
+              onChange={handleInputChange}
+              onFocus={handleInputFocus}
+              variant="outlined"
+              value={formik.values.cvc}
+              error={Boolean(formik.touched.cvc && formik.errors.cvc)}
+              helperText={formik.touched.cvc && formik.errors.cvc}
+            />
+          </div>
+          {/* {formik.errors.submit && (
+        <Typography color="error" sx={{ mt: 2 }} variant="body2">
+          {formik.errors.submit}
+        </Typography>
+      )} */}
+        </Box>
+        <Box
+          sx={{ display: "flex", flexDirection: "row", gap: 2, width: "100%" }}
+        >
+          <Box sx={{ flexGrow: 1 }}>
+            {!address ? null : (
+              <Box>
+                <Typography variant="h6" sx={{ mt: 2, mb: 3 }}>
+                  Billing Address
+                </Typography>
+                <AddressCountryField formik={formik} name="country" />
+                <AddressEmailField
+                  formik={formik}
+                  name="email"
+                  sx={{ mt: 2 }}
+                />
+                <AddressOrganizationNameField
+                  sx={{ mt: 2 }}
+                  formik={formik}
+                  name="organization"
+                />
+                <AddressStreetField
+                  sx={{ mt: 2 }}
+                  formik={formik}
+                  name="line1"
+                  lineNo="1"
+                />
+                <AddressStreetField
+                  sx={{ mt: 2 }}
+                  formik={formik}
+                  name="line2"
+                  lineNo="2"
+                  required={false}
+                />
+                <AddressCityField sx={{ mt: 2 }} formik={formik} name="city" />
+                <AddressRegionField
+                  sx={{ mt: 2 }}
+                  formik={formik}
+                  name="region"
+                />
+                <AddressPostalCodeField
+                  sx={{ mt: 2 }}
+                  formik={formik}
+                  name="postal_code"
+                />
+              </Box>
+            )}
+          </Box>
+          <Box
+            sx={{
+              mt: "16px",
+              display: "flex",
+              flexDirection: "column",
+              alignItems: "flex-end",
+              flexGrow: 1,
+            }}
+          >
+            {PriceDetails}
+          </Box>
+        </Box>
+        {error && (
+          <Typography color="error" sx={{ mt: 2 }} variant="body2">
+            {error}
+          </Typography>
+        )}
+        {formError && (
+          <Typography color="red">
+            Could not create order or calculate tax. Please double-check your
+            payment information.
+          </Typography>
+        )}
+        <Button
+          size="large"
+          sx={{ mt: 3 }}
+          variant="contained"
+          // onClick={formik.handleSubmit}
+          type="submit"
+          disabled={formDisabled}
+          color={formError ? "error" : undefined}
+        >
+          Calculate Tax
+        </Button>
+        <Box sx={{ mt: 1 }}>
+          <StripeLogoLink />
+        </Box>
+      </form>
+    </Container>
+  );
+};