@algolia/satellite 1.1.0 → 1.1.1

package/dist/esm/Fields/Form/stories/ValidationStrategies.js

@@ -0,0 +1,446 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9, _templateObject10, _templateObject11, _templateObject12, _templateObject13, _templateObject14, _templateObject15, _templateObject16, _templateObject17, _templateObject18, _templateObject19, _templateObject20;
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { zodResolver } from "@hookform/resolvers/zod";
+import { useFormik } from "formik";
+import { useState } from "react";
+import { Controller, useForm } from "react-hook-form";
+import * as yup from "yup";
+import { z } from "zod";
+import { CalendarIcon, CreditCardIcon, LockIcon } from "../../../Icons";
+import stl from "../../../styles/helpers/satellitePrefixer";
+import { Field } from "../../Field";
+import { Input } from "../../Input";
+import { ExperimentalForm, ExperimentalFormErrorMessage, ExperimentalFormReset, ExperimentalFormSubmit } from "../Form";
+import { useFormikAutoFocusOnError } from "./utils/useFormikAutoFocusOnError";
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+var initialFormData = {
+  cardOwner: "",
+  cardNumber: "",
+  cardExpirationDate: "",
+  cardCVC: ""
+};
+
+// From: https://stackoverflow.com/a/30727110/19351131
+var validateCardNumber = function validateCardNumber(cardNumber) {
+  var sum = 0;
+  var isEven = false;
+  for (var i = cardNumber.length - 1; i >= 0; i--) {
+    var digit = parseInt(cardNumber.charAt(i), 10);
+    if (isEven) {
+      digit *= 2;
+      if (digit > 9) {
+        digit -= 9;
+      }
+    }
+    sum += digit;
+    isEven = !isEven;
+  }
+  return sum % 10 === 0;
+};
+var validateExpirationDate = function validateExpirationDate(expirationMonth, expirationYear) {
+  var currentDate = new Date();
+  var currentYear = parseInt(currentDate.getFullYear().toString().slice(-2));
+  var currentMonth = currentDate.getMonth() + 1;
+  return expirationYear > currentYear || expirationYear === currentYear && expirationMonth >= currentMonth;
+};
+var validateCVC = function validateCVC(cvc) {
+  var cvcPattern = /^[0-9]{3,4}$/;
+  return cvcPattern.test(cvc);
+};
+function formatInputValue(event, digits, separator) {
+  var input = event.target.value.replace(/\D/g, "");
+  var formatted = [];
+  var index = 0;
+  while (index < input.length) {
+    var group = input.substring(index, index + digits);
+    formatted.push(group);
+    index += digits;
+  }
+  return formatted.join(separator);
+}
+var zodSchema = z.object({
+  cardOwner: z.string().min(1, {
+    message: "You must specify a card owner"
+  }),
+  cardNumber: z.string().min(1, {
+    message: "You must specify a card number"
+  }).transform(function (value) {
+    return value.replace(/\s/g, "");
+  }).refine(validateCardNumber, {
+    message: "Invalid card number (try: 5555555555554444)"
+  }),
+  cardExpirationDate: z.string().min(1, {
+    message: "You must specify a card expiration date"
+  }).refine(function (value) {
+    var _value$split = value.split("/"),
+      _value$split2 = _slicedToArray(_value$split, 2),
+      expirationMonth = _value$split2[0],
+      expirationYear = _value$split2[1];
+    return validateExpirationDate(parseInt(expirationMonth), parseInt(expirationYear));
+  }, {
+    message: "Invalid card expiration date"
+  }),
+  cardCVC: z.string().min(1, {
+    message: "You must specify a card security code"
+  }).refine(validateCVC, {
+    message: "Invalid card security code (must be 3 or 4 digits)"
+  })
+});
+export var RHFValidationStrategiesComponent = function RHFValidationStrategiesComponent() {
+  var _useState = useState(initialFormData),
+    _useState2 = _slicedToArray(_useState, 2),
+    formData = _useState2[0],
+    setFormData = _useState2[1];
+  var _useForm = useForm({
+      defaultValues: initialFormData,
+      reValidateMode: "onChange",
+      resolver: zodResolver(zodSchema)
+    }),
+    control = _useForm.control,
+    handleSubmit = _useForm.handleSubmit,
+    getFieldStateFromReactHookForm = _useForm.getFieldState,
+    formState = _useForm.formState,
+    reset = _useForm.reset,
+    trigger = _useForm.trigger;
+  var getFieldState = function getFieldState(fieldName) {
+    var _fieldState$error;
+    var fieldState = getFieldStateFromReactHookForm(fieldName, formState);
+    if ((_fieldState$error = fieldState.error) !== null && _fieldState$error !== void 0 && _fieldState$error.message) {
+      return {
+        status: "invalid",
+        errors: [fieldState.error.message]
+      };
+    } else if (!fieldState.invalid && formState.isSubmitted) {
+      return {
+        status: "validated"
+      };
+    } else {
+      return {
+        status: "default"
+      };
+    }
+  };
+  return /*#__PURE__*/_jsxs("div", {
+    className: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["flex flex-col gap-8 w-4/6"]))),
+    children: [/*#__PURE__*/_jsxs(ExperimentalForm, {
+      onSubmit: handleSubmit(function (data) {
+        return setFormData(data);
+      }),
+      onReset: function onReset() {
+        return setFormData(initialFormData);
+      },
+      className: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["flex flex-col items-start gap-4 min-w-72"]))),
+      children: [/*#__PURE__*/_jsx(ExperimentalFormErrorMessage, {}), /*#__PURE__*/_jsx(Controller, {
+        name: "cardOwner",
+        control: control,
+        render: function render(_ref) {
+          var field = _ref.field;
+          return /*#__PURE__*/_jsx(Field, {
+            label: "Card Owner",
+            labelFor: "cardOwner",
+            description: "Please enter the card owner",
+            state: getFieldState("cardOwner"),
+            className: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["w-full"]))),
+            children: /*#__PURE__*/_jsx(Input, _objectSpread({
+              id: "cardOwner",
+              placeholder: "John Doe",
+              required: true
+            }, field))
+          });
+        }
+      }), /*#__PURE__*/_jsx(Controller, {
+        name: "cardNumber",
+        control: control,
+        render: function render(_ref2) {
+          var field = _ref2.field;
+          return /*#__PURE__*/_jsx(Field, {
+            label: "Card Number",
+            labelFor: "cardNumber",
+            description: "Please enter the card number",
+            state: getFieldState("cardNumber"),
+            className: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["w-full"]))),
+            children: /*#__PURE__*/_jsx(Input, _objectSpread(_objectSpread({
+              id: "cardNumber",
+              placeholder: "Card number",
+              maxLength: 16 + 3 // 3 spaces
+              ,
+              startIcon: CreditCardIcon,
+              required: true
+            }, field), {}, {
+              onChange: function onChange(e) {
+                e.target.value = formatInputValue(e, 4, " ");
+                field.onChange(e);
+                if (e.target.value.length === 19) {
+                  trigger("cardNumber");
+                }
+              }
+            }))
+          });
+        }
+      }), /*#__PURE__*/_jsxs("div", {
+        className: stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["w-full flex gap-4"]))),
+        children: [/*#__PURE__*/_jsx(Controller, {
+          name: "cardExpirationDate",
+          control: control,
+          render: function render(_ref3) {
+            var field = _ref3.field;
+            return /*#__PURE__*/_jsx(Field, {
+              label: "Card Expiration Date",
+              labelFor: "cardExpirationDate",
+              description: "Please enter the card expiration date",
+              state: getFieldState("cardExpirationDate"),
+              className: stl(_templateObject6 || (_templateObject6 = _taggedTemplateLiteral(["w-full"]))),
+              children: /*#__PURE__*/_jsx(Input, _objectSpread(_objectSpread({
+                id: "cardExpirationDate",
+                placeholder: "MM/YY",
+                maxLength: 4 + 1 // 1 slash
+                ,
+                startIcon: CalendarIcon,
+                required: true
+              }, field), {}, {
+                onChange: function onChange(e) {
+                  e.target.value = formatInputValue(e, 2, "/");
+                  field.onChange(e);
+                },
+                onBlur: function onBlur() {
+                  trigger("cardExpirationDate");
+                  field.onBlur();
+                }
+              }))
+            });
+          }
+        }), /*#__PURE__*/_jsx(Controller, {
+          name: "cardCVC",
+          control: control,
+          render: function render(_ref4) {
+            var field = _ref4.field;
+            return /*#__PURE__*/_jsx(Field, {
+              label: "Card CVC",
+              labelFor: "cardCVC",
+              description: "Please enter the card security code",
+              state: getFieldState("cardCVC"),
+              className: stl(_templateObject7 || (_templateObject7 = _taggedTemplateLiteral(["w-full"]))),
+              children: /*#__PURE__*/_jsx(Input, _objectSpread(_objectSpread({
+                id: "cardCVC",
+                placeholder: "CVC",
+                maxLength: 4,
+                startIcon: LockIcon,
+                required: true
+              }, field), {}, {
+                onBlur: function onBlur() {
+                  trigger("cardCVC");
+                  field.onBlur();
+                }
+              }))
+            });
+          }
+        })]
+      }), /*#__PURE__*/_jsxs("div", {
+        className: stl(_templateObject8 || (_templateObject8 = _taggedTemplateLiteral(["flex gap-2"]))),
+        children: [/*#__PURE__*/_jsx(ExperimentalFormSubmit, {
+          variant: "primary",
+          "aria-label": "Save the form",
+          children: "Save"
+        }), /*#__PURE__*/_jsx(ExperimentalFormReset, {
+          "aria-label": "Reset the form",
+          onClick: function onClick() {
+            return reset();
+          },
+          children: "Reset"
+        })]
+      })]
+    }), /*#__PURE__*/_jsx("hr", {
+      className: stl(_templateObject9 || (_templateObject9 = _taggedTemplateLiteral(["text-grey-500"])))
+    }), /*#__PURE__*/_jsx("code", {
+      className: stl(_templateObject10 || (_templateObject10 = _taggedTemplateLiteral(["whitespace-pre"]))),
+      children: JSON.stringify(formData, null, 2)
+    })]
+  });
+};
+var yupSchema = yup.object({
+  cardOwner: yup.string().required("You must specify a card owner"),
+  cardNumber: yup.string().required("You must specify a card number").transform(function (value) {
+    return value.replace(/\s/g, "");
+  }).test("cardNumber", "Invalid card number (try: 5555555555554444)", validateCardNumber),
+  cardExpirationDate: yup.string().required("You must specify a card expiration date").test("cardExpirationDate", "Invalid card expiration date", function (value) {
+    var _value$split3 = value.split("/"),
+      _value$split4 = _slicedToArray(_value$split3, 2),
+      expirationMonth = _value$split4[0],
+      expirationYear = _value$split4[1];
+    return validateExpirationDate(parseInt(expirationMonth), parseInt(expirationYear));
+  }),
+  cardCVC: yup.string().required("You must specify a card security code").test("cardCVC", "Invalid card security code (must be 3 or 4 digits)", validateCVC)
+});
+export var FormikValidationStrategiesComponent = function FormikValidationStrategiesComponent() {
+  var _useState3 = useState(initialFormData),
+    _useState4 = _slicedToArray(_useState3, 2),
+    formData = _useState4[0],
+    setFormData = _useState4[1];
+  var _useState5 = useState(false),
+    _useState6 = _slicedToArray(_useState5, 2),
+    revalidationEnabled = _useState6[0],
+    setRevalidationEnabled = _useState6[1];
+  var formik = useFormik({
+    initialValues: initialFormData,
+    validateOnChange: revalidationEnabled,
+    validateOnBlur: revalidationEnabled,
+    validationSchema: yupSchema,
+    onSubmit: function onSubmit(values) {
+      return setFormData(values);
+    },
+    onReset: function onReset() {
+      return setFormData(initialFormData);
+    }
+  });
+  var getFieldState = function getFieldState(fieldName) {
+    var fieldMeta = formik.getFieldMeta(fieldName);
+    if (fieldMeta.error) {
+      return {
+        status: "invalid",
+        errors: [fieldMeta.error]
+      };
+    } else if (formik.isSubmitting && fieldMeta.touched) {
+      return {
+        status: "validated"
+      };
+    } else {
+      return {
+        status: "default"
+      };
+    }
+  };
+  useFormikAutoFocusOnError(formik);
+  return /*#__PURE__*/_jsxs("div", {
+    className: stl(_templateObject11 || (_templateObject11 = _taggedTemplateLiteral(["flex flex-col gap-8 w-4/6"]))),
+    children: [/*#__PURE__*/_jsxs(ExperimentalForm, {
+      onSubmit: function onSubmit(e) {
+        setRevalidationEnabled(true);
+        formik.handleSubmit(e);
+      },
+      onReset: function onReset(e) {
+        setRevalidationEnabled(false);
+        formik.handleReset(e);
+      },
+      className: stl(_templateObject12 || (_templateObject12 = _taggedTemplateLiteral(["flex flex-col items-start gap-4 min-w-72"]))),
+      children: [/*#__PURE__*/_jsx(ExperimentalFormErrorMessage, {}), /*#__PURE__*/_jsx(Field, {
+        label: "Card Owner",
+        labelFor: "cardOwner",
+        description: "Please enter the card owner",
+        state: getFieldState("cardOwner"),
+        className: stl(_templateObject13 || (_templateObject13 = _taggedTemplateLiteral(["w-full"]))),
+        children: /*#__PURE__*/_jsx(Input, _objectSpread({
+          id: "cardOwner",
+          placeholder: "John Doe",
+          required: true
+        }, formik.getFieldProps("cardOwner")))
+      }), /*#__PURE__*/_jsx(Field, {
+        label: "Card Number",
+        labelFor: "cardNumber",
+        description: "Please enter the card number",
+        state: getFieldState("cardNumber"),
+        className: stl(_templateObject14 || (_templateObject14 = _taggedTemplateLiteral(["w-full"]))),
+        children: /*#__PURE__*/_jsx(Input, _objectSpread(_objectSpread({
+          id: "cardNumber",
+          placeholder: "Card number",
+          maxLength: 16 + 3 // 3 spaces
+          ,
+          startIcon: CreditCardIcon,
+          required: true
+        }, formik.getFieldProps("cardNumber")), {}, {
+          onChange: /*#__PURE__*/function () {
+            var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(e) {
+              var value;
+              return _regeneratorRuntime.wrap(function _callee$(_context) {
+                while (1) switch (_context.prev = _context.next) {
+                  case 0:
+                    value = formatInputValue(e, 4, " ");
+                    _context.next = 3;
+                    return formik.setFieldValue("cardNumber", value);
+                  case 3:
+                    if (value.length === 19) {
+                      formik.validateField("cardNumber");
+                    }
+                  case 4:
+                  case "end":
+                    return _context.stop();
+                }
+              }, _callee);
+            }));
+            return function (_x) {
+              return _ref5.apply(this, arguments);
+            };
+          }()
+        }))
+      }), /*#__PURE__*/_jsxs("div", {
+        className: stl(_templateObject15 || (_templateObject15 = _taggedTemplateLiteral(["w-full flex gap-4"]))),
+        children: [/*#__PURE__*/_jsx(Field, {
+          label: "Card Expiration Date",
+          labelFor: "cardExpirationDate",
+          description: "Please enter the card expiration date",
+          state: getFieldState("cardExpirationDate"),
+          className: stl(_templateObject16 || (_templateObject16 = _taggedTemplateLiteral(["w-full"]))),
+          children: /*#__PURE__*/_jsx(Input, _objectSpread(_objectSpread({
+            id: "cardExpirationDate",
+            placeholder: "MM/YY",
+            maxLength: 4 + 1 // 1 slash
+            ,
+            startIcon: CalendarIcon,
+            required: true
+          }, formik.getFieldProps("cardExpirationDate")), {}, {
+            onChange: function onChange(e) {
+              e.target.value = formatInputValue(e, 2, "/");
+              formik.getFieldProps("cardExpirationDate").onChange(e);
+            },
+            onBlur: function onBlur(e) {
+              formik.validateField("cardExpirationDate");
+              formik.getFieldProps("cardExpirationDate").onBlur(e);
+            }
+          }))
+        }), /*#__PURE__*/_jsx(Field, {
+          label: "Card CVC",
+          labelFor: "cardCVC",
+          description: "Please enter the card security code",
+          state: getFieldState("cardCVC"),
+          className: stl(_templateObject17 || (_templateObject17 = _taggedTemplateLiteral(["w-full"]))),
+          children: /*#__PURE__*/_jsx(Input, _objectSpread(_objectSpread({
+            id: "cardCVC",
+            placeholder: "CVC",
+            maxLength: 4,
+            startIcon: LockIcon,
+            required: true
+          }, formik.getFieldProps("cardCVC")), {}, {
+            onBlur: function onBlur(e) {
+              formik.validateField("cardCVC");
+              formik.getFieldProps("cardCVC").onBlur(e);
+            }
+          }))
+        })]
+      }), /*#__PURE__*/_jsxs("div", {
+        className: stl(_templateObject18 || (_templateObject18 = _taggedTemplateLiteral(["flex gap-2"]))),
+        children: [/*#__PURE__*/_jsx(ExperimentalFormSubmit, {
+          variant: "primary",
+          "aria-label": "Save the form",
+          children: "Save"
+        }), /*#__PURE__*/_jsx(ExperimentalFormReset, {
+          "aria-label": "Reset the form",
+          onClick: function onClick() {
+            return formik.resetForm();
+          },
+          children: "Reset"
+        })]
+      })]
+    }), /*#__PURE__*/_jsx("hr", {
+      className: stl(_templateObject19 || (_templateObject19 = _taggedTemplateLiteral(["text-grey-500"])))
+    }), /*#__PURE__*/_jsx("code", {
+      className: stl(_templateObject20 || (_templateObject20 = _taggedTemplateLiteral(["whitespace-pre"]))),
+      children: JSON.stringify(formData, null, 2)
+    })]
+  });
+};

package/dist/esm/Fields/Input/Input.d.ts

@@ -0,0 +1,27 @@
+import type { InputHTMLAttributes, ReactNode } from "react";
+import type { IconComponentType } from "../../Icons";
+export declare type InputVariant = "small" | "medium" | "large";
+export declare type InputStatus = "default" | "validated" | "invalid";
+export declare type InputPropsLocale = {
+    clearInput?: string;
+    increment?: string;
+    decrement?: string;
+};
+export interface InputProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "checked" | "defaultChecked"> {
+    type?: "text" | "number" | "search" | "email" | "password";
+    variant?: InputVariant;
+    startIcon?: IconComponentType;
+    endItem?: ReactNode;
+    /**
+     * Define whether or not a "clear input" x button should show on hover
+     * @default false
+     */
+    clearable?: boolean;
+    locale?: InputPropsLocale;
+}
+/**
+ * The `Input` component is a flexible, user-friendly component for efficient text and number entry across forms and applications.
+ *
+ * See the [Input documentation page](https://satellite.algolia.com/components/forms/input) for more information.
+ */
+export declare const Input: import("react").ForwardRefExoticComponent<InputProps & import("react").RefAttributes<HTMLInputElement>>;