@springmicro/cart 0.2.0-alpha.3 → 0.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@springmicro/cart",
   "private": false,
-  "version": "0.2.0-alpha.3",
+  "version": "0.2.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
-    "dev": "vite",
+    "dev": "vite build --watch",
     "build": "rm -rf dist && vite build",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "preview": "vite preview"
@@ -23,11 +23,14 @@
     "@nanostores/persistent": "^0.10.1",
     "@nanostores/query": "^0.3.3",
     "@nanostores/react": "^0.7.2",
+    "@springmicro/utils": "0.2.0",
     "dotenv": "^16.4.5",
     "nanostores": "^0.10.3",
     "react": "^18.2.0",
+    "react-credit-cards-2": "^1.0.2",
     "react-dom": "^18.2.0",
-    "unstorage": "^1.10.2"
+    "unstorage": "^1.10.2",
+    "vite-plugin-dts": "^3.9.0"
   },
   "devDependencies": {
     "@types/react": "^18.2.66",
@@ -38,8 +41,11 @@
     "eslint": "^8.57.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.6",
+    "formik": "^2.4.6",
     "typescript": "^5.2.2",
-    "vite": "^5.2.0"
+    "vite": "^5.2.0",
+    "vite-plugin-css-injected-by-js": "^3.5.1",
+    "yup": "^1.4.0"
   },
-  "gitHead": "0854b518932e657d4c08fb5877c725a9425b36e9"
+  "gitHead": "bada90b1f5c1efcd122b4a69436098408162677c"
 }

package/src/checkout/Address.tsx

@@ -0,0 +1,265 @@
+import { FormikProps } from "formik";
+import {
+  allCountries,
+  allProvinces,
+  allCountriesReverse,
+  getRegionLabel,
+  getPostalCodeLabel,
+  getPostalCodeDefault,
+  provinces,
+} from "@springmicro/utils/address";
+import type { Alpha2Code, Province } from "@springmicro/utils/address";
+import React from "react";
+import { useEffect, useState } from "react";
+import { SxProps } from "@mui/material";
+import MenuItem from "@mui/material/MenuItem";
+import Box from "@mui/material/Box";
+import TextField, { StandardTextFieldProps } from "@mui/material/TextField";
+import Autocomplete from "@mui/material/Autocomplete";
+
+export type AddressValues = {
+  country: string;
+  region: string;
+  line1: string;
+  line2?: string;
+  organization?: string;
+  email: string;
+  city: string;
+  postal_code: string;
+};
+
+export type AddressFieldProps = {
+  formik: FormikProps<AddressValues & any>; // formik object might contain other values in addition to address
+  name: keyof AddressValues;
+  sx?: SxProps;
+};
+
+export function AddressCountryField({ formik, name, sx }: AddressFieldProps) {
+  /**
+   * Selects the full country name, need to do a reverse lookup for the Alpha2Code.
+   */
+  const [inputValue, setInputValue] = useState(formik.values[name] as string);
+
+  return (
+    <Autocomplete
+      sx={{ width: 300, ...sx }}
+      options={Object.values(allCountries)}
+      autoHighlight
+      getOptionLabel={(option) => option}
+      value={formik.values[name] as string}
+      onChange={(e, newValue) => {
+        // console.log(newValue)
+        formik.setValues({
+          ...formik.values,
+          region: "",
+          country: newValue as string,
+          line1: "",
+          line2: "",
+          organization: "",
+          city: "",
+          postal_code: "",
+        });
+      }}
+      onBlur={formik.handleBlur}
+      inputValue={inputValue}
+      onInputChange={(event, newInputValue) => {
+        setInputValue(newInputValue);
+      }}
+      renderOption={(props, option) => (
+        <Box
+          component="li"
+          sx={{ "& > img": { mr: 2, flexShrink: 0 } }}
+          {...props}
+        >
+          <img
+            loading="lazy"
+            width="20"
+            src={`https://flagcdn.com/w20/${allCountriesReverse[
+              option
+            ].toLowerCase()}.png`}
+            srcSet={`https://flagcdn.com/w40/${allCountriesReverse[
+              option
+            ].toLowerCase()}.png 2x`}
+            alt=""
+          />
+          {option}
+        </Box>
+      )}
+      renderInput={(params) => (
+        <TextField
+          {...params}
+          required={true}
+          name={name as string}
+          label="Country"
+        />
+      )}
+    />
+  );
+}
+
+export function AddressRegionField({ formik, name, sx }: AddressFieldProps) {
+  const [addressRegionFieldOptional, setAddressRegionFieldOptional] =
+    useState<boolean>(false);
+  const country2code = allCountriesReverse[
+    formik.values["country"] as string
+  ] as Alpha2Code;
+
+  useEffect(() => {
+    setAddressRegionFieldOptional(
+      provinces.filter(
+        (province: Province) => province.country === country2code
+      ).length === 0
+    );
+  }, [country2code]);
+
+  const baseProps = {
+    sx: { width: 300, ...sx },
+    label: getRegionLabel(country2code),
+    name: name as string,
+    id: name as string,
+    value: formik.values[name],
+    onChange: formik.handleChange,
+    onBlur: formik.handleBlur,
+  };
+
+  if (!country2code || !getRegionLabel(country2code)) {
+    return <></>;
+  }
+
+  if (addressRegionFieldOptional) {
+    return (
+      <TextField
+        {...baseProps}
+        required={false}
+        sx={{ display: "block", ...baseProps.sx }}
+      />
+    );
+  } else {
+    return (
+      <TextField {...baseProps} select required={true}>
+        {allProvinces
+          .filter((val) => val.country === country2code)
+          .map((province, i) => (
+            <MenuItem key={i} value={province.value}>
+              {province.name}
+            </MenuItem>
+          ))}
+      </TextField>
+    );
+  }
+}
+
+export function AddressStreetField({
+  formik,
+  name,
+  sx,
+  required = true,
+  lineNo,
+}: AddressFieldProps & {
+  required?: boolean;
+  lineNo?: "1" | "2" | "3" | undefined;
+}) {
+  return (
+    <>
+      <TextField
+        label={lineNo ? `Street Address ${lineNo}` : "Street Address"}
+        sx={{ width: 400, display: "block", ...sx }}
+        name={name as string}
+        id={name as string}
+        value={formik.values[name]}
+        onChange={formik.handleChange}
+        onBlur={formik.handleBlur}
+        required={required}
+      />
+    </>
+  );
+}
+
+export function AddressEmailField({ formik, name, sx }: AddressFieldProps) {
+  return (
+    <>
+      <TextField
+        label={"Email"}
+        sx={{ width: 400, display: "block", ...sx }}
+        name={name as string}
+        id={name as string}
+        value={formik.values[name]}
+        onChange={formik.handleChange}
+        onBlur={formik.handleBlur}
+        type="email"
+        required={true}
+      />
+    </>
+  );
+}
+
+export function AddressOrganizationNameField({
+  formik,
+  name,
+  sx,
+}: AddressFieldProps) {
+  return (
+    <TextField
+      label="Organization Name"
+      sx={{ width: 400, display: "block", ...sx }}
+      name={name as string}
+      id={name as string}
+      value={formik.values[name]}
+      onChange={formik.handleChange}
+      onBlur={formik.handleBlur}
+      required={false}
+      helperText="Only include organization name if you want it included on the address."
+    />
+  );
+}
+
+export function AddressCityField({ formik, name, sx }: AddressFieldProps) {
+  return (
+    <TextField
+      label="City"
+      sx={{ width: 400, display: "block", ...sx }}
+      name={name as string}
+      id={name as string}
+      value={formik.values[name]}
+      onChange={formik.handleChange}
+      onBlur={formik.handleBlur}
+      required={true}
+    />
+  );
+}
+
+export function AddressPostalCodeField({
+  formik,
+  name,
+  sx,
+}: AddressFieldProps) {
+  const country2code = allCountriesReverse[
+    formik.values["country"] as string
+  ] as Alpha2Code;
+
+  React.useEffect(() => {
+    if (!!getPostalCodeDefault(country2code)) {
+      formik
+        .setFieldValue(name, getPostalCodeDefault(country2code))
+        .then(() => formik.setFieldTouched(name, true));
+    }
+  }, [country2code]);
+
+  return (
+    <TextField
+      label={getPostalCodeLabel(country2code)}
+      sx={{ width: 400, display: "block", ...sx }}
+      name={name as string}
+      id={name as string}
+      value={formik.values[name]}
+      onChange={formik.handleChange}
+      onBlur={formik.handleBlur}
+      required={true}
+      helperText={
+        !!getPostalCodeDefault(country2code)
+          ? 'Our records indicate that your country does not have a postal code system, so "00000" will be used by default.'
+          : ""
+      }
+    />
+  );
+}

package/src/checkout/Billing.tsx

@@ -0,0 +1,346 @@
+import { useFormik, FormikProps } from "formik";
+import * as Yup from "yup";
+import { ChangeEventHandler, useEffect } from "react";
+import { 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";
+
+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>;
+};
+
+export const AddCard = ({
+  contact,
+  error,
+  stacked = false,
+  address = true,
+  onSubmit,
+}: AddCardProps) => {
+  const [disabled, setDisabled] = useState(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 ? allCountries[initialCountry] : "",
+    email: contact?.email ?? "",
+    region: "",
+    line1: "",
+    line2: "",
+    organization: contact?.organization ?? "",
+    city: "",
+    postal_code: getPostalCodeDefault(initialCountry),
+  } as AddressValues;
+
+  // const initialValues = { ...initialValuesBase, ...initialValuesAddress }
+  const initialValues = 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 (values, helpers) => {
+      if (disabled) {
+        throw new Error("Attempted to submit an invalid form.");
+      }
+      if (onSubmit) {
+        if (address) {
+          // match backend
+          // @ts-ignore
+          values["street_address"] = values.line2
+            ? // @ts-ignore
+              `${values.line1}\n${values.line2}`
+            : // @ts-ignore
+              values.line1;
+          // @ts-ignore
+          values["locality"] = values.city;
+          // @ts-ignore
+          delete values.line1;
+          // @ts-ignore
+          delete values.line2;
+          // @ts-ignore
+          delete values.city;
+          // @ts-ignore
+          if (Object.keys(allCountriesReverse).includes(values.country)) {
+            // @ts-ignore
+            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 onSubmit(values);
+      }
+    },
+  });
+
+  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(() => {
+    setDisabled(Object.keys(formik.errors).length > 0);
+  }, [formik.errors]);
+
+  return (
+    <Container id="paymentMethodForm">
+      <form
+        onSubmit={(e) => {
+          e.preventDefault();
+          formik.handleSubmit();
+        }}
+      >
+        <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>
+          {!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>
+        {error && (
+          <Typography color="error" sx={{ mt: 2 }} variant="body2">
+            {error}
+          </Typography>
+        )}
+        <Button
+          size="large"
+          sx={{ mt: 3 }}
+          variant="contained"
+          type="submit"
+          disabled={disabled}
+        >
+          Continue
+        </Button>
+        <Box sx={{ mt: 1 }}>
+          <StripeLogoLink />
+        </Box>
+      </form>
+    </Container>
+  );
+};