@kiva/kv-shop 1.1.0

package/README.md

@@ -0,0 +1,57 @@
+# kv-shop
+
+A library of methods and components related to the Kiva Shop.
+
+## Install
+
+Deployed:
+
+```bash
+npm i @kiva/kv-shop
+```
+
+Local:
+
+```bash
+# Open kv-ui-elements folder in Terminal
+npm link -w @kiva/kv-shop
+
+# Open target local project folder in Terminal
+npm link @kiva/kv-shop
+```
+
+Extra step for Nuxt local development:
+
+```ts
+// Open nuxt.config.ts in target project and add with your username
+...
+vite: {
+    optimizeDeps: {
+      exclude: ['@kiva/kv-shop'],
+    },
+    server: {
+      fs: {
+        allow: ['/Users/username/kiva/kv-ui-elements'],
+      },
+    },
+  },
+...
+```
+
+## Lint
+
+```bash
+npm run lint
+```
+
+## Build
+
+```bash
+npm run build
+```
+
+## Contribution Guidelines
+
+The Kiva UI project is bound by a [Code of Conduct](https://github.com/kiva/ui/blob/master/code_of_conduct.md).
+
+Kiva welcomes outside contributions to our UI repository. If you have any ideas for a feature or improvement, create an issue and we can discuss whether it makes sense to create a pull request. Thanks for the help!

package/dist/basket.cjs

@@ -0,0 +1,40 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/basket.ts
+var basket_exports = {};
+__export(basket_exports, {
+  getBasketID: () => getBasketID,
+  setBasketID: () => setBasketID
+});
+module.exports = __toCommonJS(basket_exports);
+var getCookieValue = (name) => {
+  if (typeof document !== void 0) {
+    return document.cookie.match(`(^|;)\\s*${name}\\s*=\\s*([^;]+)/`)?.pop() || "";
+  }
+};
+function getBasketID() {
+  return getCookieValue("kvbskt");
+}
+function setBasketID(basketId) {
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getBasketID,
+  setBasketID
+});

package/dist/basket.d.ts

@@ -0,0 +1,4 @@
+declare function getBasketID(): string;
+declare function setBasketID(basketId: string): void;
+
+export { getBasketID, setBasketID };

package/dist/basket.js

@@ -0,0 +1,8 @@
+import {
+  getBasketID,
+  setBasketID
+} from "./chunk-AEVGXKI6.js";
+export {
+  getBasketID,
+  setBasketID
+};

package/dist/basketItems.cjs

@@ -0,0 +1,116 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/basketItems.ts
+var basketItems_exports = {};
+__export(basketItems_exports, {
+  setTipDonation: () => setTipDonation
+});
+module.exports = __toCommonJS(basketItems_exports);
+var import_client = require("@apollo/client");
+var import_numeral = __toESM(require("numeral"), 1);
+
+// src/basket.ts
+var getCookieValue = (name) => {
+  if (typeof document !== void 0) {
+    return document.cookie.match(`(^|;)\\s*${name}\\s*=\\s*([^;]+)/`)?.pop() || "";
+  }
+};
+function getBasketID() {
+  return getCookieValue("kvbskt");
+}
+
+// src/shopError.ts
+var ShopError = class extends Error {
+  constructor({ code, original }, ...params) {
+    super(...params);
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ShopError);
+    }
+    this.name = "ShopError";
+    this.code = code;
+    this.original = original;
+  }
+};
+function parseShopError(error) {
+  const errorCode = error?.code ?? error?.name ?? "";
+  const errorMessage = typeof error === "string" ? error : error?.message ?? "";
+  if (errorCode === "invalidMethodParameter" && errorMessage.includes("paymentMethod.create")) {
+    return new ShopError({
+      code: "paymentMethod.create.invalidMethodParameter",
+      original: error
+    }, "There was a problem validating your payment information. Please double-check the details and try again.");
+  }
+  return new ShopError({
+    code: "shop.unknown",
+    original: error
+  }, "An unknown error occurred.");
+}
+
+// src/basketItems.ts
+async function setTipDonation({ amount, apollo }) {
+  let data;
+  let error;
+  try {
+    const result = await apollo.mutate({
+      mutation: import_client.gql`mutation setTipDonation($price: Money!, $basketId: String) {
+				shop (basketId: $basketId) {
+					id
+					updateDonation (donation: {
+						price: $price,
+						isTip: true
+					})
+					{
+						id
+						price
+						isTip
+					}
+				}
+			}`,
+      variables: {
+        price: (0, import_numeral.default)(amount).format("0.00"),
+        basketId: getBasketID()
+      }
+    });
+    if (result.error || result.errors.length) {
+      error = result.error ?? result.errors[0];
+    } else {
+      data = result.data;
+    }
+  } catch (e) {
+    error = e;
+  }
+  if (error) {
+    throw parseShopError(error);
+  }
+  return data?.shop?.updateDonation;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  setTipDonation
+});

package/dist/basketItems.d.ts

@@ -0,0 +1,7 @@
+interface SetTipDonationOptions {
+    amount: string | number;
+    apollo: any;
+}
+declare function setTipDonation({ amount, apollo }: SetTipDonationOptions): Promise<any>;
+
+export { SetTipDonationOptions, setTipDonation };

package/dist/basketItems.js

@@ -0,0 +1,8 @@
+import {
+  setTipDonation
+} from "./chunk-CBOAIFK6.js";
+import "./chunk-AEVGXKI6.js";
+import "./chunk-H35VQXDR.js";
+export {
+  setTipDonation
+};

package/dist/chunk-AEVGXKI6.js

@@ -0,0 +1,16 @@
+// src/basket.ts
+var getCookieValue = (name) => {
+  if (typeof document !== void 0) {
+    return document.cookie.match(`(^|;)\\s*${name}\\s*=\\s*([^;]+)/`)?.pop() || "";
+  }
+};
+function getBasketID() {
+  return getCookieValue("kvbskt");
+}
+function setBasketID(basketId) {
+}
+
+export {
+  getBasketID,
+  setBasketID
+};

package/dist/chunk-CBOAIFK6.js

@@ -0,0 +1,51 @@
+import {
+  getBasketID
+} from "./chunk-AEVGXKI6.js";
+import {
+  parseShopError
+} from "./chunk-H35VQXDR.js";
+
+// src/basketItems.ts
+import { gql } from "@apollo/client";
+import numeral from "numeral";
+async function setTipDonation({ amount, apollo }) {
+  let data;
+  let error;
+  try {
+    const result = await apollo.mutate({
+      mutation: gql`mutation setTipDonation($price: Money!, $basketId: String) {
+				shop (basketId: $basketId) {
+					id
+					updateDonation (donation: {
+						price: $price,
+						isTip: true
+					})
+					{
+						id
+						price
+						isTip
+					}
+				}
+			}`,
+      variables: {
+        price: numeral(amount).format("0.00"),
+        basketId: getBasketID()
+      }
+    });
+    if (result.error || result.errors.length) {
+      error = result.error ?? result.errors[0];
+    } else {
+      data = result.data;
+    }
+  } catch (e) {
+    error = e;
+  }
+  if (error) {
+    throw parseShopError(error);
+  }
+  return data?.shop?.updateDonation;
+}
+
+export {
+  setTipDonation
+};

package/dist/chunk-H35VQXDR.js

@@ -0,0 +1,31 @@
+// src/shopError.ts
+var ShopError = class extends Error {
+  constructor({ code, original }, ...params) {
+    super(...params);
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, ShopError);
+    }
+    this.name = "ShopError";
+    this.code = code;
+    this.original = original;
+  }
+};
+function parseShopError(error) {
+  const errorCode = error?.code ?? error?.name ?? "";
+  const errorMessage = typeof error === "string" ? error : error?.message ?? "";
+  if (errorCode === "invalidMethodParameter" && errorMessage.includes("paymentMethod.create")) {
+    return new ShopError({
+      code: "paymentMethod.create.invalidMethodParameter",
+      original: error
+    }, "There was a problem validating your payment information. Please double-check the details and try again.");
+  }
+  return new ShopError({
+    code: "shop.unknown",
+    original: error
+  }, "An unknown error occurred.");
+}
+
+export {
+  ShopError,
+  parseShopError
+};

package/dist/chunk-KIVWMRDA.js

@@ -0,0 +1,26 @@
+// src/oneTimeCheckout.ts
+import { gql } from "@apollo/client";
+async function executeOneTimeCheckout({ apollo }) {
+}
+async function waitOnTransaction({ apollo, transactionId }) {
+  const result = await apollo.query({
+    query: gql`
+			query checkoutStatus($transactionId: String!, $visitorId: string) {
+				checkoutStatus(transactionId: $transactionId, visitorId: $visitorId) {
+					errorCode
+					errorMessage
+					status
+					transactionId
+				}
+			}
+		`,
+    variables: {
+      transactionId
+    }
+  });
+}
+
+export {
+  executeOneTimeCheckout,
+  waitOnTransaction
+};

package/dist/chunk-NC732HHG.js

@@ -0,0 +1,160 @@
+import {
+  ShopError,
+  parseShopError
+} from "./chunk-H35VQXDR.js";
+
+// src/useBraintreeDropIn.ts
+import { gql } from "@apollo/client";
+import numeral from "numeral";
+import { ref } from "vue-demi";
+var defaultPaymentTypes = ["paypal", "card", "applePay", "googlePay"];
+async function getClientToken(apollo) {
+  const { data, error, errors } = await apollo.query({
+    query: gql`query getClientToken {
+			shop {
+				id
+				getClientToken(useCustomerId: true)
+			}
+		}`
+  });
+  if (error || errors.length) {
+    throw parseShopError(error ?? errors[0]);
+  }
+  return data?.shop?.getClientToken;
+}
+function useBraintreeDropIn() {
+  let instance;
+  let formattedAmount = "";
+  const paymentMethodRequestable = ref(false);
+  function getApplePaymentRequest(amount) {
+    return {
+      countryCode: "US",
+      currencyCode: "USD",
+      // merchantCapabilities: ['supports3DS'], // TODO: confirm/update
+      requiredBillingContactFields: ["postalAddress"],
+      // supportedNetworks: ['amex', 'discover', 'interac', 'jcb', 'masterCard', 'visa'], // TODO: confirm/update
+      total: {
+        label: "Kiva",
+        amount
+      }
+    };
+  }
+  function getGoogleTransactionInfo(amount) {
+    return {
+      totalPriceStatus: "FINAL",
+      totalPrice: amount,
+      currencyCode: "USD",
+      countryCode: "US"
+    };
+  }
+  function initDropInActions() {
+    if (instance.isPaymentMethodRequestable()) {
+      paymentMethodRequestable.value = true;
+    }
+    instance.on("paymentMethodRequestable", (event) => {
+      paymentMethodRequestable.value = true;
+    });
+    instance.on("noPaymentMethodRequestable", () => {
+      paymentMethodRequestable.value = false;
+    });
+  }
+  async function initDropIn({
+    amount,
+    authToken,
+    container,
+    googlePayMerchantId,
+    paymentTypes = [...defaultPaymentTypes],
+    preselectVaultedPaymentMethod = true,
+    paypalFlow = "checkout"
+  }) {
+    formattedAmount = numeral(amount).format("0.00");
+    const { default: DropIn } = await import("braintree-web-drop-in");
+    try {
+      instance = await DropIn.create({
+        authorization: authToken,
+        container,
+        dataCollector: {
+          kount: true
+          // Required if Kount fraud data collection is enabled
+        },
+        // vaultManager: true, - Useful for testing and removing payment methods easily.
+        paymentOptionPriority: paymentTypes,
+        preselectVaultedPaymentMethod,
+        card: {
+          vault: {
+            allowVaultCardOverride: true
+          }
+        },
+        paypal: {
+          flow: paypalFlow,
+          amount: formattedAmount,
+          currency: "USD",
+          buttonStyle: {
+            // @ts-ignore
+            color: "gold",
+            // @ts-ignore
+            shape: "rect",
+            // @ts-ignore
+            size: "responsive"
+          }
+        },
+        googlePay: {
+          googlePayVersion: 2,
+          merchantId: googlePayMerchantId,
+          transactionInfo: getGoogleTransactionInfo(formattedAmount),
+          button: {
+            allowedPaymentMethods: [{
+              type: "CARD",
+              // @ts-ignore
+              parameters: {
+                // allowedAuthMethods: ['PAN_ONLY', 'CRYPTOGRAM_3DS'], // TODO: confirm/update
+                // allowedCardNetworks: ['AMEX', 'DISCOVER', 'INTERAC', 'JCB', 'MASTERCARD', 'VISA'], // TODO: confirm/update
+                billingAddressRequired: true,
+                billingAddressParameters: {
+                  format: "FULL"
+                }
+              }
+            }]
+          }
+        },
+        applePay: {
+          displayName: "Kiva",
+          paymentRequest: getApplePaymentRequest(formattedAmount)
+        }
+      });
+      initDropInActions();
+    } catch (e) {
+      throw new ShopError({
+        code: "shop.braintreeDropinInitError",
+        original: e
+      }, "An Error has occured. Please refresh the page and try again.");
+    }
+    return instance;
+  }
+  async function requestPaymentMethod() {
+    if (instance.isPaymentMethodRequestable()) {
+      return instance.requestPaymentMethod();
+    }
+  }
+  function updateAmount(amount) {
+    const newAmount = numeral(amount).format("0.00");
+    if (newAmount !== formattedAmount) {
+      formattedAmount = newAmount;
+      instance?.updateConfiguration("paypal", "amount", formattedAmount);
+      instance?.updateConfiguration("googlePay", "transactionInfo", getGoogleTransactionInfo(formattedAmount));
+      instance?.updateConfiguration?.("applePay", "paymentRequest", getApplePaymentRequest(formattedAmount));
+    }
+  }
+  return {
+    initDropIn,
+    paymentMethodRequestable,
+    requestPaymentMethod,
+    updateAmount
+  };
+}
+
+export {
+  defaultPaymentTypes,
+  getClientToken,
+  useBraintreeDropIn
+};

package/dist/chunk-PAW2TVX4.js

@@ -0,0 +1,104 @@
+import {
+  ShopError,
+  parseShopError
+} from "./chunk-H35VQXDR.js";
+
+// src/subscriptionCheckout.ts
+import { gql } from "@apollo/client";
+async function checkSubscriptionStatus(apollo) {
+  const { data: subsData } = await apollo.query({
+    query: gql`query subscriptionStatus{
+			my {
+				id
+				subscriptions {
+					totalCount
+				}
+				autoDeposit {
+					id
+					isSubscriber
+				}
+			}
+		}`
+  });
+  if (!subsData?.my?.id) {
+    throw new ShopError({ code: "api.authenticationRequired" }, "You must be logged in to continue.");
+  }
+  if ((subsData?.my?.subscriptions?.totalCount ?? 0) > 0 || subsData?.my?.autoDeposit?.isSubscriber) {
+    throw new ShopError({ code: "shop.subscriptionExists" }, "You already have an existing Monthly Good subscription. Changes can be made in your subscription settings.");
+  }
+  if (subsData?.my?.autoDeposit?.id) {
+    throw new ShopError({ code: "shop.autoDepositExists" }, "You already have existing Auto Deposit settings. Changes can be made in your subscription settings.");
+  }
+  return true;
+}
+async function executeNewSubscriptionCheckout({
+  amount,
+  apollo,
+  dayOfMonth = (/* @__PURE__ */ new Date()).getDate(),
+  donateAmount,
+  paymentMethod
+}) {
+  const amountRegex = new RegExp(/^\d+\.\d{2}$/);
+  if (!amountRegex.test(amount) || !amountRegex.test(donateAmount)) {
+    throw new ShopError({
+      code: "api.invalidMethodParameter"
+    }, "Please check that the amount is correct and try again.");
+  }
+  await checkSubscriptionStatus(apollo);
+  const { deviceData, nonce } = paymentMethod;
+  let data;
+  let error;
+  try {
+    const result = await apollo.query({
+      variables: {
+        dayOfMonth,
+        deviceData,
+        nonce
+      },
+      query: gql`mutation createAutoDepositSubscription(
+				$nonce: String!,
+				$deviceData: String,
+				$amount: Money!,
+				$donateAmount: Money!,
+				$dayOfMonth: Int!
+			) {
+				my {
+					createAutoDeposit (
+						autoDeposit: {
+							amount: $amount,
+							donateAmount: $donateAmount,
+							dayOfMonth: $dayOfMonth,
+						},
+						deviceData: $deviceData,
+						paymentMethodNonce: $nonce
+					) {
+						id amount donateAmount dayOfMonth status
+					}
+				}
+			}`
+    });
+    if (result.error || result.errors.length) {
+      error = result.error ?? result.errors[0];
+    } else {
+      data = result.data;
+    }
+  } catch (e) {
+    error = e;
+  }
+  if (error) {
+    const parsed = parseShopError(error);
+    if (parsed.code === "shop.unknown") {
+      throw new ShopError({
+        code: "shop.createAutoDepositError",
+        original: parsed
+      }, "There was a problem trying to setup your monthly deposit.");
+    }
+    throw parsed;
+  }
+  return data?.my?.createAutoDeposit;
+}
+
+export {
+  checkSubscriptionStatus,
+  executeNewSubscriptionCheckout
+};