@payloadcms/storage-r2 0.0.1-beta.0

package/src/endpoints/confirmOrder.ts

@@ -0,0 +1,312 @@
+import { addDataAndFileToRequest, type DefaultDocumentIDType, type Endpoint } from 'payload'
+
+import type { CurrenciesConfig, PaymentAdapter, ProductsValidation } from '../types.js'
+
+import { defaultProductsValidation } from '../utilities/defaultProductsValidation.js'
+
+type Args = {
+  /**
+   * The slug of the carts collection, defaults to 'carts'.
+   */
+  cartsSlug?: string
+  currenciesConfig: CurrenciesConfig
+  /**
+   * The slug of the customers collection, defaults to 'users'.
+   */
+  customersSlug?: string
+  /**
+   * The slug of the orders collection, defaults to 'orders'.
+   */
+  ordersSlug?: string
+  paymentMethod: PaymentAdapter
+  /**
+   * The slug of the products collection, defaults to 'products'.
+   */
+  productsSlug?: string
+  /**
+   * Customise the validation used for checking products or variants before a transaction is created.
+   */
+  productsValidation?: ProductsValidation
+  /**
+   * The slug of the transactions collection, defaults to 'transactions'.
+   */
+  transactionsSlug?: string
+  /**
+   * The slug of the variants collection, defaults to 'variants'.
+   */
+  variantsSlug?: string
+}
+
+type ConfirmOrderHandler = (args: Args) => Endpoint['handler']
+
+/**
+ * Handles the endpoint for initiating payments. We will handle checking the amount and product and variant prices here before it is sent to the payment provider.
+ * This is the first step in the payment process.
+ */
+export const confirmOrderHandler: ConfirmOrderHandler =
+  ({
+    cartsSlug = 'carts',
+    currenciesConfig,
+    customersSlug = 'users',
+    ordersSlug = 'orders',
+    paymentMethod,
+    productsSlug = 'products',
+    productsValidation,
+    transactionsSlug = 'transactions',
+    variantsSlug = 'variants',
+  }) =>
+  async (req) => {
+    await addDataAndFileToRequest(req)
+
+    const data = req.data
+    const payload = req.payload
+    const user = req.user
+
+    let currency: string = currenciesConfig.defaultCurrency
+    let cartID: DefaultDocumentIDType = data?.cartID
+    let cart = undefined
+    let customerEmail: string = user?.email ?? ''
+
+    if (user) {
+      if (user.cart?.docs && Array.isArray(user.cart.docs) && user.cart.docs.length > 0) {
+        if (!cartID && user.cart.docs[0]) {
+          // Use the user's cart instead
+          if (typeof user.cart.docs[0] === 'object') {
+            cartID = user.cart.docs[0].id
+            cart = user.cart.docs[0]
+          } else {
+            cartID = user.cart.docs[0]
+          }
+        }
+      }
+    } else {
+      // Get the email from the data if user is not available
+      if (data?.customerEmail && typeof data.customerEmail === 'string') {
+        customerEmail = data.customerEmail
+      } else {
+        return Response.json(
+          {
+            message: 'A customer email is required to make a purchase.',
+          },
+          {
+            status: 400,
+          },
+        )
+      }
+    }
+
+    if (!cart) {
+      if (cartID) {
+        cart = await payload.findByID({
+          id: cartID,
+          collection: cartsSlug,
+          depth: 2,
+          overrideAccess: false,
+          select: {
+            id: true,
+            currency: true,
+            customerEmail: true,
+            items: true,
+            subtotal: true,
+          },
+          user,
+        })
+
+        if (!cart) {
+          return Response.json(
+            {
+              message: `Cart with ID ${cartID} not found.`,
+            },
+            {
+              status: 404,
+            },
+          )
+        }
+      } else {
+        return Response.json(
+          {
+            message: 'Cart ID is required.',
+          },
+          {
+            status: 400,
+          },
+        )
+      }
+    }
+
+    if (cart.currency && typeof cart.currency === 'string') {
+      currency = cart.currency
+    }
+
+    // Ensure the currency is provided or inferred in some way
+    if (!currency) {
+      return Response.json(
+        {
+          message: 'Currency is required.',
+        },
+        {
+          status: 400,
+        },
+      )
+    }
+
+    try {
+      if (Array.isArray(cart.items) && cart.items.length > 0) {
+        for (const item of cart.items) {
+          // Target field to check the price based on the currency so we can validate the total
+          const priceField = `priceIn${currency.toUpperCase()}`
+          const quantity = item.quantity || 1
+
+          // If the item has a product but no variant, we assume the product has a price in the specified currency
+          if (item.product) {
+            const id = typeof item.product === 'object' ? item.product.id : item.product
+
+            const product = await payload.findByID({
+              id,
+              collection: productsSlug,
+              depth: 0,
+              select: {
+                [priceField]: true,
+              },
+            })
+
+            if (!product) {
+              payload.logger.error(
+                `Product with ID ${item.product} not found.`,
+                'Error validating product',
+              )
+
+              return Response.json(
+                {
+                  message: `Product with ID ${item.product} not found.`,
+                },
+                {
+                  status: 404,
+                },
+              )
+            }
+
+            // Run product validation only if the item does not have a variant, each variant will have its own inventory and price
+            if (!item.variant) {
+              try {
+                if (productsValidation) {
+                  await productsValidation({
+                    currenciesConfig,
+                    currency,
+                    product,
+                    quantity,
+                  })
+                } else {
+                  await defaultProductsValidation({
+                    currenciesConfig,
+                    currency,
+                    product,
+                    quantity,
+                  })
+                }
+              } catch (error) {
+                payload.logger.error(error, 'Error validating product.')
+                return Response.json(
+                  {
+                    message: error,
+                  },
+                  {
+                    status: 400,
+                  },
+                )
+              }
+            }
+
+            if (item.variant) {
+              const id = typeof item.variant === 'object' ? item.variant.id : item.variant
+
+              const variant = await payload.findByID({
+                id,
+                collection: variantsSlug,
+                depth: 0,
+                select: {
+                  inventory: true,
+                  [priceField]: true,
+                },
+              })
+
+              if (!variant) {
+                payload.logger.error(
+                  `Variant with ID ${item.variant} not found.`,
+                  'Error validating variant',
+                )
+
+                return Response.json(
+                  {
+                    message: `Variant with ID ${item.variant} not found.`,
+                  },
+                  {
+                    status: 404,
+                  },
+                )
+              }
+
+              try {
+                if (productsValidation) {
+                  await productsValidation({
+                    currenciesConfig,
+                    currency,
+                    product,
+                    quantity,
+                    variant,
+                  })
+                } else {
+                  await defaultProductsValidation({
+                    currenciesConfig,
+                    currency,
+                    product,
+                    quantity,
+                    variant,
+                  })
+                }
+              } catch (error) {
+                payload.logger.error(error, 'Error validating product or variant.')
+
+                return Response.json(
+                  {
+                    message: error,
+                  },
+                  {
+                    status: 400,
+                  },
+                )
+              }
+            }
+          }
+        }
+      }
+
+      const paymentResponse = await paymentMethod.confirmOrder({
+        customersSlug,
+        data: {
+          ...data,
+          customerEmail,
+        },
+        ordersSlug,
+        req,
+        transactionsSlug,
+      })
+
+      if (paymentResponse) {
+        // Start decrementing the inventory for each product and variant in the cart
+      }
+
+      return Response.json(paymentResponse)
+    } catch (error) {
+      payload.logger.error(error, 'Error initiating payment')
+
+      return Response.json(
+        {
+          message: 'Error confirming order.',
+        },
+        {
+          status: 500,
+        },
+      )
+    }
+  }

package/src/endpoints/initiatePayment.ts

@@ -0,0 +1,322 @@
+import { addDataAndFileToRequest, type DefaultDocumentIDType, type Endpoint } from 'payload'
+
+import type {
+  CurrenciesConfig,
+  PaymentAdapter,
+  ProductsValidation,
+  SanitizedEcommercePluginConfig,
+} from '../types.js'
+
+import { defaultProductsValidation } from '../utilities/defaultProductsValidation.js'
+
+type Args = {
+  /**
+   * The slug of the carts collection, defaults to 'carts'.
+   */
+  cartsSlug?: string
+  currenciesConfig: CurrenciesConfig
+  /**
+   * The slug of the customers collection, defaults to 'users'.
+   */
+  customersSlug?: string
+  /**
+   * Track inventory stock for the products and variants.
+   * Accepts an object to override the default field name.
+   */
+  inventory?: SanitizedEcommercePluginConfig['inventory']
+  paymentMethod: PaymentAdapter
+  /**
+   * The slug of the products collection, defaults to 'products'.
+   */
+  productsSlug?: string
+  /**
+   * Customise the validation used for checking products or variants before a transaction is created.
+   */
+  productsValidation?: ProductsValidation
+  /**
+   * The slug of the transactions collection, defaults to 'transactions'.
+   */
+  transactionsSlug?: string
+  /**
+   * The slug of the variants collection, defaults to 'variants'.
+   */
+  variantsSlug?: string
+}
+
+type InitiatePayment = (args: Args) => Endpoint['handler']
+
+/**
+ * Handles the endpoint for initiating payments. We will handle checking the amount and product and variant prices here before it is sent to the payment provider.
+ * This is the first step in the payment process.
+ */
+export const initiatePaymentHandler: InitiatePayment =
+  ({
+    cartsSlug = 'carts',
+    currenciesConfig,
+    customersSlug = 'users',
+    paymentMethod,
+    productsSlug = 'products',
+    productsValidation,
+    transactionsSlug = 'transactions',
+    variantsSlug = 'variants',
+  }) =>
+  async (req) => {
+    await addDataAndFileToRequest(req)
+    const data = req.data
+    const payload = req.payload
+    const user = req.user
+
+    let currency: string = currenciesConfig.defaultCurrency
+    let cartID: DefaultDocumentIDType = data?.cartID
+    let cart = undefined
+    const billingAddress = data?.billingAddress
+    const shippingAddress = data?.shippingAddress
+
+    let customerEmail: string = user?.email ?? ''
+
+    if (user) {
+      if (user.cart?.docs && Array.isArray(user.cart.docs) && user.cart.docs.length > 0) {
+        if (!cartID && user.cart.docs[0]) {
+          // Use the user's cart instead
+          if (typeof user.cart.docs[0] === 'object') {
+            cartID = user.cart.docs[0].id
+            cart = user.cart.docs[0]
+          } else {
+            cartID = user.cart.docs[0]
+          }
+        }
+      }
+    } else {
+      // Get the email from the data if user is not available
+      if (data?.customerEmail && typeof data.customerEmail === 'string') {
+        customerEmail = data.customerEmail
+      } else {
+        return Response.json(
+          {
+            message: 'A customer email is required to make a purchase.',
+          },
+          {
+            status: 400,
+          },
+        )
+      }
+    }
+
+    if (!cart) {
+      if (cartID) {
+        cart = await payload.findByID({
+          id: cartID,
+          collection: cartsSlug,
+          depth: 2,
+          overrideAccess: false,
+          select: {
+            id: true,
+            currency: true,
+            customerEmail: true,
+            items: true,
+            subtotal: true,
+          },
+          user,
+        })
+
+        if (!cart) {
+          return Response.json(
+            {
+              message: `Cart with ID ${cartID} not found.`,
+            },
+            {
+              status: 404,
+            },
+          )
+        }
+      } else {
+        return Response.json(
+          {
+            message: 'Cart ID is required.',
+          },
+          {
+            status: 400,
+          },
+        )
+      }
+    }
+
+    if (cart.currency && typeof cart.currency === 'string') {
+      currency = cart.currency
+    }
+
+    // Ensure the currency is provided or inferred in some way
+    if (!currency) {
+      return Response.json(
+        {
+          message: 'Currency is required.',
+        },
+        {
+          status: 400,
+        },
+      )
+    }
+
+    // Ensure the selected currency is supported
+    if (
+      !currenciesConfig.supportedCurrencies.find(
+        (c) => c.code.toLocaleLowerCase() === currency.toLocaleLowerCase(),
+      )
+    ) {
+      return Response.json(
+        {
+          message: `Currency ${currency} is not supported.`,
+        },
+        {
+          status: 400,
+        },
+      )
+    }
+
+    // Verify the cart is available and items are present in an array
+    if (!cart || !cart.items || !Array.isArray(cart.items) || cart.items.length === 0) {
+      return Response.json(
+        {
+          message: 'Cart is required and must contain at least one item.',
+        },
+        {
+          status: 400,
+        },
+      )
+    }
+
+    for (const item of cart.items) {
+      // Target field to check the price based on the currency so we can validate the total
+      const priceField = `priceIn${currency.toUpperCase()}`
+      const quantity = item.quantity || 1
+
+      // If the item has a product but no variant, we assume the product has a price in the specified currency
+      if (item.product && !item.variant) {
+        const id = typeof item.product === 'object' ? item.product.id : item.product
+
+        const product = await payload.findByID({
+          id,
+          collection: productsSlug,
+          depth: 0,
+          select: {
+            [priceField]: true,
+          },
+        })
+
+        if (!product) {
+          return Response.json(
+            {
+              message: `Product with ID ${item.product} not found.`,
+            },
+            {
+              status: 404,
+            },
+          )
+        }
+
+        try {
+          if (productsValidation) {
+            await productsValidation({ currenciesConfig, currency, product, quantity })
+          } else {
+            await defaultProductsValidation({
+              currenciesConfig,
+              currency,
+              product,
+              quantity,
+            })
+          }
+        } catch (error) {
+          return Response.json(
+            {
+              message: error,
+            },
+            {
+              status: 400,
+            },
+          )
+        }
+
+        if (item.variant) {
+          const id = typeof item.variant === 'object' ? item.variant.id : item.variant
+
+          const variant = await payload.findByID({
+            id,
+            collection: variantsSlug,
+            depth: 0,
+            select: {
+              inventory: true,
+              [priceField]: true,
+            },
+          })
+
+          if (!variant) {
+            return Response.json(
+              {
+                message: `Variant with ID ${item.variant} not found.`,
+              },
+              {
+                status: 404,
+              },
+            )
+          }
+
+          try {
+            if (productsValidation) {
+              await productsValidation({
+                currenciesConfig,
+                currency,
+                product: item.product,
+                quantity,
+                variant,
+              })
+            } else {
+              await defaultProductsValidation({
+                currenciesConfig,
+                currency,
+                product: item.product,
+                quantity,
+                variant,
+              })
+            }
+          } catch (error) {
+            return Response.json(
+              {
+                message: error,
+              },
+              {
+                status: 400,
+              },
+            )
+          }
+        }
+      }
+    }
+
+    try {
+      const paymentResponse = await paymentMethod.initiatePayment({
+        customersSlug,
+        data: {
+          billingAddress,
+          cart,
+          currency,
+          customerEmail,
+          shippingAddress,
+        },
+        req,
+        transactionsSlug,
+      })
+
+      return Response.json(paymentResponse)
+    } catch (error) {
+      payload.logger.error(error, 'Error initiating payment.')
+
+      return Response.json(
+        {
+          message: 'Error initiating payment.',
+        },
+        {
+          status: 500,
+        },
+      )
+    }
+  }

package/src/exports/addresses.ts

@@ -0,0 +1,2 @@
+export { addressesCollection } from '../addresses/addressesCollection.js'
+export { defaultCountries } from '../addresses/defaultCountries.js'

package/src/exports/currencies.ts

@@ -0,0 +1 @@
+export { EUR, GBP, JPY, USD } from '../currencies/index.js'

package/src/exports/fields.ts

@@ -0,0 +1,5 @@
+export { amountField } from '../fields/amountField.js'
+export { currencyField } from '../fields/currencyField.js'
+export { pricesField } from '../fields/pricesField.js'
+export { statusField } from '../fields/statusField.js'
+export { variantsFields } from '../fields/variantsFields.js'

package/src/exports/orders.ts

@@ -0,0 +1 @@
+export { ordersCollection } from '../orders/ordersCollection.js'

package/src/exports/payments/stripe.ts

@@ -0,0 +1 @@
+export { stripeAdapter, stripeAdapterClient } from '../../payments/adapters/stripe/index.js'

package/src/exports/plugin.ts

@@ -0,0 +1 @@
+export { ecommercePlugin } from '../index.js'

package/src/exports/products.ts

@@ -0,0 +1 @@
+export { productsCollection } from '../products/productsCollection.js'

package/src/exports/react.ts

@@ -0,0 +1,8 @@
+export {
+  EcommerceProvider,
+  useAddresses,
+  useCart,
+  useCurrency,
+  useEcommerce,
+  usePayments,
+} from '../react/provider/index.js'

package/src/exports/transactions.ts

@@ -0,0 +1 @@
+export { transactionsCollection } from '../transactions/transactionsCollection.js'

package/src/exports/translations.ts

@@ -0,0 +1 @@
+export { en } from '../translations/en.js'

package/src/exports/types.ts

@@ -0,0 +1,7 @@
+export type {
+  Cart,
+  CollectionOverride,
+  CurrenciesConfig,
+  EcommercePluginConfig,
+  FieldsOverride,
+} from '../types.js'

package/src/exports/ui.ts

@@ -0,0 +1,3 @@
+export { PriceInput } from '../ui/PriceInput/index.js'
+export { PriceRowLabel } from '../ui/PriceRowLabel/index.js'
+export { VariantOptionsSelector } from '../ui/VariantOptionsSelector/index.js'

package/src/exports/variants.ts

@@ -0,0 +1,5 @@
+export { variantOptionsCollection } from '../variants/variantOptionsCollection.js'
+
+export { variantsCollection } from '../variants/variantsCollection/index.js'
+
+export { variantTypesCollection } from '../variants/variantTypesCollection.js'