@merchi/cart 1.4.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Merchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,134 @@
+# @merchi/cart
+Merchi's cart
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Props](#props)
+
+## Installation
+
+```bash
+npm install @merchi/cart
+
+or
+
+yarn add @merchi/cart
+```
+
+### Usage
+  context functions:
+
+  components:
+  ButtonOpenCart
+  ButtonListWrappedOpenCart
+  MerchiCart
+  MerchiCartModal
+  MerchiShoppingCartModal
+
+  context functions:
+  setCartComplete - Resets the cart
+  refetchCart - refetches the cart
+  createCartAndCookie - clears and resets the cart with a new cookie
+  getCartShipmentOptions - refetches the cart shipment options
+
+  window functions:
+  addCartItem - takes job json and creates a cart item
+  getCart - fetches the cart
+  getMerchiCartValues - retruns the following:
+    cart
+    cartItemsCount
+    currency
+    subtotalCost
+    taxAmount
+    totalCost
+  isMerchiCartFetching - checks the fetching state of the cart
+  setCartComplete - Resets the cart
+  toggleCartOpen - open close cart modal
+  refetchCart - refetches the cart
+  createCartAndCookie = clears and resets the cart with a new cookie
+
+
+### Props
+
+| Name                                          | Type       | Default                                                                     | Description                           |
+|-----------------------------------------------|------------|-----------------------------------------------------------------------------|---------------------------------------|
+| `cart`                                        | `cartJson Object || undefined`| `"{}"`                                                   | `Pass in a cart to init the cart state in the provider`|
+| `classNameAlertError`                         | `string?`  | `"alert alert-danger"`                                                      | `Class for alert error`               |
+| `classNameAlertInfo`                          | `string?`  | `"alert alert-info"`                                                        | `Class for alert info`                |
+| `classNameAlertSuccess`                       | `string?`  | `"alert alert-success"`                                                     | `Class for alert success`             |
+| `classNameAlertWarning`                       | `string?`  | `"alert alert-warning"`                                                     | `Class for alert warning`             |
+| `classNameBtn`                                | `string?`  | `"btn"`                                                                     | `Base class for button elements`      |
+| `classNameBtnBack`                            | `string?`  | `"btn-lg btn-default pull-left"`                                            | `Class for back button`               |
+| `classNameBtnCartClear`                       | `string?`  | `"btn-lg btn-danger mr-auto"`                                               | `Class for clear cart button`         |
+| `classNameBtnClose`                           | `string?`  | `"btn-close"`                                                               | `Class for close button element`      |
+| `classNameBtnDanger`                          | `string?`  | `"btn btn-md btn-danger"`                                                   | `Class for button danger element`     |
+| `classNameBtnDownloadInvoice`                 | `string?`  | `"btn btn-lg btn-primary"`                                                  | `Class for button download element`   |
+| `classNameBtnLink`                            | `string?`  | `"btn-md btn-link"`                                                         | `Class for link button elements`      |
+| `classNameBtnNext`                            | `string?`  | `"btn-lg btn-primary"`                                                      | `Class for next button`               |
+| `classNameBtnNextComplete`                    | `string?`  | `"btn-lg btn-success"`                                                      | `Class for next button completed`     |
+| `classNameBtnPay`                             | `string?`  | `"btn-lg btn-primary width-full"`                                           | `Class for pay button completed`      |
+| `classNameBtnPrimary`                         | `string?`  | `"btn btn-md btn-primary"`                                                  | `Class for edit cart item button`     |
+| `classNameBtnEditCartItem`                    | `string?`  | `"btn btn-md btn-primary ml-auto"`                                          | `Class for primary button completed`  |
+| `classNameCartBody`                           | `string?`  | `"merchi-cart-body"`                                                        | `Class for cart body container`       |
+| `classNameCartFooter`                         | `string?`  | `"merchi-cart-footer"`                                                      | `Class for cart footer container`     |
+| `classNameCartFormGroup`                      | `string?`  | `"form-group merchi-form-group"`                                            | `Class for form group element`        |
+| `classNameCartFormGroupButton`                | `string?`  | `"merchi-form-group-button"`                                                | `Class for form group button`         |
+| `classNameCartFormGroupCheckbox`              | `string?`  | `"form-check"`                                                              | `Class for form group checkbox`       |
+| `classNameCartFormInput`                      | `string?`  | `"form-control"`                                                            | `Class for form input`                |
+| `classNameCartFormLabelCheckbox`              | `string?`  | `""`                                                                        | `Class for form input checkbpx label` |
+| `classNameCartFormCheckbox`                   | `string?`  | `"form-check-input"`                                                        | `Class for form input checkbpx`       |
+| `classNameCartHeader`                         | `string?`  | `"merchi-cart-header"`                                                      | `Class for cart header container`     |
+| `classNameCartInputError`                     | `string?`  | `"text-danger"`                                                             | `Class for form error`                |
+| `classNameCartNav`                            | `string?`  | `"nav merchi-nav-tabs merchi-nav merchi-nav-fill merchi-nav-pills"`                | `Class for cart nav`                  |
+| `classNameNoItems`                            | `string?`  | `"merchi-no-cart-items"`                                                    | `Class for no items in cart`          |
+| `classNameCartGoogleSuggestList`              | `string?`  | `"list-group m-b-0"`                                                        | `Class for google suggest list`       |
+| `classNameCartGoogleSuggestListItem`          | `string?`  | `"list-group-item cursor-pointer"`                                          | `Class for google suggest list item`  |
+| `classNameCartItemFeatureImage`               | `string?`  | `"img-rounded m-10"`                                                        | `Class for cart item feature image`   |
+| `classNameCartItemInfo`                       | `string?`  | `"text-muted font-weight-normal font-italic"`                               | `Class for cart item info element`    |
+| `classNameCartItemInfoCell`                   | `string?`  | `"border-0 align-middle"`                                                   | `Class for cart item cell`            |
+| `classNameCartItemInfoCellRight`              | `string?`  | `"border-0 align-middle text-right"`                                        | `Class for cart item cell right align`|
+| `classNameCartItemInfoContainer`              | `string?`  | `"ml-3 d-inline-block align-middle"`                                        | `Class for cart item info container`  |
+| `classNameCartRow`                            | `string?`  | `"merchi-row"`                                                              | `Class for row element`               |
+| `classNameCartRowColumn`                      | `string?`  | `"merchi-column"`                                                           | `Class for row column element`        |
+| `classNameTableContainer`                     | `string?`  | `"table-responsive"`                                                        | `Class for cart table container`      |
+| `classNameCartTab`                            | `string?`  | `"merchi-tab-content"`                                                      | `Class for cart tab container`        |
+| `classNameCartTabItem`                        | `string?`  | `"nav-item merchi-nav-item"`                                                | `Class for cart tab item`             |
+| `classNameCartTabItemLink`                    | `string?`  | `"merchi-nav-link"`                                                | `Class for cart tab item link         |` 
+| `classNameCartTitle`                          | `string?`  | `"merchi-cart-title"`                                                       | `Class for cart Title container`      |
+| `classNameCartTotalContainer`                 | `string?`  | `"merchi-cart-total-container"`                                             | `Class for totals container elements` |
+| `classNameCartToggleIconButton`               | `string?`  | `"cart-icon-button-class"`                                                  | `Class for toggle modal button`       |
+| `classNameCartTotalItem`                      | `string?`  | `"merchi-cart-total-item"`                                                  | `Class for totals item elements`      |
+| `classNameCartTotalItemPrice`                 | `string?`  | `"merchi-cart-total-item-price"`                                            | `Class for totals item price elements`|
+| `classNameClearCartContainer`                 | `string?`  | `"merchi-cart-clear-container"`                                             | `Class cart clear container`          |
+| `classNameClearCartText`                      | `string?`  | `"merchi-cart-clear-text"`                                                  | `Class cart clear text container`     |
+| `classNameListClientInfo`                     | `string?`  | `"merchi-cart-client-info-list"`                                            | `Class for client info list`          |
+| `classNameListContainer`                      | `string?`  | `"pb-2"`                                                                    | `Class for list conatiner element`    |
+| `classNameCartTotaListContainer`              | `string?`  | `"merchi-cart-total-list-container"`                                        | `Class for list conatiner for cart totlas element`|
+| `classNameListItem`                           | `string?`  | `"list-group-item"`                                                         | `Class for list item elements`        |
+| `classNameListItemCartTotals`                 | `string?`  | `"list-group-item d-flex justify-content-between align-items-center"`       | `Class for list item cart totals elements`|
+| `classNameList`                               | `string?`  | `"list-group"`                                                              | `Class for list elements`             |
+| `classNameListInline`                         | `string?`  | `"list-inline"`                                                             | `Class for list inline elements`      |
+| `classNameListUnstyles`                       | `string?`  | `"list-unstyled"`                                                           | `Class for list unstyled elements`    |
+| `classNameLoadingTemplate`                    | `string?`  | `"merchi-loading-template"`                                                 | `Class for loading elements`          |
+| `classNameLoadingTemplateContainer`           | `string?`  | `"merchi-loading-template-container"`                                       | `Class for loading container elements`|
+| `classNameShipmentOption`                     | `string?`  | `"merchi-shipment-option"`                                                  | `Class for shipment option element`   |
+| `classNameTable`                              | `string?`  | `"table"`                                                    | `Class for table elements`            |
+| `classNameVariationsList`                     | `string?`  | `"list-unstyled list-inline"`                                               | `Class for variation info`            |
+| `customSuccessMessage`                        | `string?`  | `undefined`                                                                 | `A message to display on payment success` |
+| `domainId`                                    | `number`   | `undefined`                                                                 | `The merchi domain/store id for the cart` |
+| `footer`                                      | `ReactElement`| `undefined`                                                              | `A customer footer component` |
+| `hideHead`                                    | `boolean`  | `false`                                                                     | `hides the cart head title and close` |
+| `includeTheme`                                | `boolean?` | `false`                                                                     | `If true will fetch and apply the store theme to the page` |
+| `initialiseCart`                              | `boolean?` | `true`                                                                      | `If true will initial fetch cart and set cart function on window`|
+| `onClickClose`                                | `() => void?`| `() => console.log('close merchi cart!')`                                 | `a function to close the cart`        |
+| `setIsCartModalOpen`                          | `(isOpen: boolean) => void?`| `() => console.log('close merchi cart!')`                  | `a function to open/close cart modal wrapper`|
+| `isCartModalOpen`                             | `boolean`  | `false`                                                                     | `a boolean value to control the cart modal open/closed`|
+| `productFormClassNames`                       | `obj`      | `{}`                                                                        | `An object to be passed to @merchi/product-form` |
+| `showUserTermsAndConditions`                  | `boolean?` | `true`                                                                      | `Display the user t&cs for Merchi`    |
+| `showCartItemInfo`                  | `boolean?` | `true`                                                                      | `Will display the cart item info in the cart items table`|
+| `apiUrl`                                      | `string?`  | `'https://api.merchi.co/v6/'`                                               | `URL to connect to the Merchi API`    |
+| `urlFrontend`                                 | `string?`  | `'https://merchi.co/'`                                                      | `URL to redirect users to a frontend` |
+| `urlTrackingPage`                             | `string?`  | `undefined`                                                                 | `URL used on the thankyou page for tracking`|

package/esm/Cart.js

@@ -0,0 +1,62 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+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; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import * as React from 'react';
+import { Suspense, lazy } from 'react';
+import CartAlert from './CartAlert';
+import CartHeader from './CartHeader';
+import CartNav from './tabs/CartNav';
+import CartTotals from './CartTotals';
+import CartProvider, { useCartContext } from './CartProvider';
+import { ButtonBack, ButtonClearCart, ButtonNextDynamic } from './buttons';
+import { CartFooter, CartPaymentSettingsInvalid, LoadingTemplate } from './components';
+import { LoadingTemplateSm } from './components/LoadingTemplate';
+import PanelCartItems from './panels/PanelCartItems';
+import PanelCartShipment from './panels/PanelCartShipment';
+import PanelClearCart from './panels/PanelClearCart';
+import PanelPaymentSuccess from './panels/PanelPaymentSuccess';
+import { tabIdCheckout, tabIdClearCart, tabIdItem, tabIdPaymentSuccess } from './utilities/tabs';
+import './styles/globals.css';
+
+// Heavy panels: keep out of the initial cart chunk until their tab is opened.
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+var PanelClientCheckout = /*#__PURE__*/lazy(function () {
+  return import('./panels/PanelClientCheckout');
+});
+var PanelEditCartItem = /*#__PURE__*/lazy(function () {
+  return import('./panels/PanelEditCartItem');
+});
+export function CartComponents(_ref) {
+  var footer = _ref.footer;
+  var _useCartContext = useCartContext(),
+    activeTabIndex = _useCartContext.activeTabIndex,
+    cart = _useCartContext.cart,
+    cartSettingsInvalid = _useCartContext.cartSettingsInvalid,
+    fetchingCart = _useCartContext.fetchingCart,
+    hideHead = _useCartContext.hideHead;
+  return /*#__PURE__*/_jsxs(_Fragment, {
+    children: [!hideHead && /*#__PURE__*/_jsx(CartHeader, {}), /*#__PURE__*/_jsx(CartAlert, {}), /*#__PURE__*/_jsx(CartNav, {}), fetchingCart ? /*#__PURE__*/_jsx(LoadingTemplate, {}) : cartSettingsInvalid ? /*#__PURE__*/_jsx(CartPaymentSettingsInvalid, {}) : /*#__PURE__*/_jsxs("div", {
+      className: "merchi-tab-pane",
+      children: [/*#__PURE__*/_jsx(PanelClearCart, {}), /*#__PURE__*/_jsxs(Suspense, {
+        fallback: /*#__PURE__*/_jsx(LoadingTemplateSm, {}),
+        children: [activeTabIndex === tabIdItem && /*#__PURE__*/_jsx(PanelEditCartItem, {
+          cart: cart
+        }), activeTabIndex === tabIdCheckout && /*#__PURE__*/_jsx(PanelClientCheckout, {})]
+      }), /*#__PURE__*/_jsx(PanelCartItems, {}), /*#__PURE__*/_jsx(PanelCartShipment, {}), /*#__PURE__*/_jsx(PanelPaymentSuccess, {}), ![tabIdItem, tabIdClearCart, tabIdPaymentSuccess].includes(activeTabIndex) && /*#__PURE__*/_jsxs(_Fragment, {
+        children: [activeTabIndex !== tabIdCheckout && /*#__PURE__*/_jsx(CartTotals, {}), footer || /*#__PURE__*/_jsxs(CartFooter, {
+          children: [/*#__PURE__*/_jsx(ButtonBack, {}), /*#__PURE__*/_jsx(ButtonClearCart, {}), /*#__PURE__*/_jsx(ButtonNextDynamic, {})]
+        })]
+      })]
+    })]
+  });
+}
+export default function Cart(props) {
+  return /*#__PURE__*/_jsx(CartProvider, _objectSpread(_objectSpread({}, props), {}, {
+    children: /*#__PURE__*/_jsx(CartComponents, {
+      footer: props.footer
+    })
+  }));
+}

package/esm/CartAlert.js

@@ -0,0 +1,47 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+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; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faTimes } from '@fortawesome/free-solid-svg-icons';
+import { Alert } from './components';
+import { useCartContext } from './CartProvider';
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+function CartAlert() {
+  var _useCartContext = useCartContext(),
+    alert = _useCartContext.alert,
+    classNameBtnClose = _useCartContext.classNameBtnClose,
+    setAlert = _useCartContext.setAlert;
+  var icon = alert.icon,
+    message = alert.message,
+    show = alert.show,
+    title = alert.title;
+  return /*#__PURE__*/_jsx(_Fragment, {
+    children: show && /*#__PURE__*/_jsxs(Alert, {
+      alertType: alert.type,
+      children: [/*#__PURE__*/_jsxs("h5", {
+        children: [icon && /*#__PURE__*/_jsx(FontAwesomeIcon, {
+          icon: icon
+        }), " ", /*#__PURE__*/_jsx("strong", {
+          children: title
+        }), " ", message]
+      }), /*#__PURE__*/_jsx("button", {
+        type: "button",
+        className: classNameBtnClose,
+        "data-bs-dismiss": "alert",
+        "aria-label": "Close",
+        onClick: function onClick() {
+          return setAlert(_objectSpread(_objectSpread({}, alert), {}, {
+            show: false
+          }));
+        },
+        children: /*#__PURE__*/_jsx(FontAwesomeIcon, {
+          icon: faTimes
+        })
+      })]
+    })
+  });
+}
+export default CartAlert;

package/esm/CartHeader.js

@@ -0,0 +1,29 @@
+import * as React from 'react';
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faShoppingCart, faTimes } from '@fortawesome/free-solid-svg-icons';
+import { useCartContext } from './CartProvider';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+function CartHeader() {
+  var _useCartContext = useCartContext(),
+    classNameCartHeader = _useCartContext.classNameCartHeader,
+    classNameBtnClose = _useCartContext.classNameBtnClose,
+    onClickClose = _useCartContext.onClickClose,
+    toggleCartModal = _useCartContext.toggleCartModal;
+  return /*#__PURE__*/_jsxs("div", {
+    className: classNameCartHeader,
+    children: [/*#__PURE__*/_jsxs("h5", {
+      children: [/*#__PURE__*/_jsx(FontAwesomeIcon, {
+        icon: faShoppingCart
+      }), ' ', "Shopping cart"]
+    }), /*#__PURE__*/_jsx("button", {
+      type: "button",
+      className: classNameBtnClose,
+      "aria-label": "Close",
+      onClick: onClickClose || toggleCartModal,
+      children: /*#__PURE__*/_jsx(FontAwesomeIcon, {
+        icon: faTimes
+      })
+    })]
+  });
+}
+export default CartHeader;