@payloadcms/storage-r2 0.0.1-beta.0 → 3.50.0-internal.ca62628

package/src/react/provider/types.ts

@@ -1,184 +0,0 @@
-import type { DefaultDocumentIDType, PopulateType, SelectType, TypedCollection } from 'payload'
-import type React from 'react'
-
-import type { CurrenciesConfig, Currency, PaymentAdapterClient } from '../../types.js'
-
-export type SyncLocalStorageConfig = {
-  /**
-   * Key to use for localStorage.
-   * Defaults to 'cart'.
-   */
-  key?: string
-}
-
-type APIProps = {
-  /**
-   * The route for the Payload API, defaults to `/api`.
-   */
-  apiRoute?: string
-  /**
-   * Customise the query used to fetch carts. Use this when you need to fetch additional data and optimise queries using depth, select and populate.
-   *
-   * Defaults to `{ depth: 0 }`.
-   */
-  cartsFetchQuery?: {
-    depth?: number
-    populate?: PopulateType
-    select?: SelectType
-  }
-  /**
-   * The route for the Payload API, defaults to ``. Eg for a Payload app running on `http://localhost:3000`, the default serverURL would be `http://localhost:3000`.
-   */
-  serverURL?: string
-}
-
-export type ContextProps = {
-  /**
-   * The slug for the addresses collection.
-   *
-   * Defaults to 'addresses'.
-   */
-  addressesSlug?: string
-  api?: APIProps
-  /**
-   * The slug for the carts collection.
-   *
-   * Defaults to 'carts'.
-   */
-  cartsSlug?: string
-  children?: React.ReactNode
-  /**
-   * The configuration for currencies used in the ecommerce context.
-   * This is used to handle currency formatting and calculations, defaults to USD.
-   */
-  currenciesConfig?: CurrenciesConfig
-  /**
-   * The slug for the customers collection.
-   *
-   * Defaults to 'users'.
-   */
-  customersSlug?: string
-  /**
-   * Enable debug mode for the ecommerce context. This will log additional information to the console.
-   * Defaults to false.
-   */
-  debug?: boolean
-  /**
-   * Whether to enable support for variants in the cart.
-   * This allows adding products with specific variants to the cart.
-   * Defaults to false.
-   */
-  enableVariants?: boolean
-  /**
-   * Supported payment methods for the ecommerce context.
-   */
-  paymentMethods?: PaymentAdapterClient[]
-  /**
-   * Whether to enable localStorage for cart persistence.
-   * Defaults to true.
-   */
-  syncLocalStorage?: boolean | SyncLocalStorageConfig
-}
-
-/**
- * Type used internally to represent the cart item to be added.
- */
-type CartItemArgument = {
-  /**
-   * The ID of the product to add to the cart. Always required.
-   */
-  product: DefaultDocumentIDType
-  /**
-   * The ID of the variant to add to the cart. Optional, if not provided, the product will be added without a variant.
-   */
-  variant?: DefaultDocumentIDType
-}
-
-export type EcommerceContext = {
-  /**
-   * Add an item to the cart.
-   */
-  addItem: (item: CartItemArgument, quantity?: number) => Promise<void>
-  /**
-   * All current addresses for the current user.
-   * This is used to manage shipping and billing addresses.
-   */
-  addresses?: TypedCollection['addresses'][]
-  /**
-   * The current data of the cart.
-   */
-  cart?: TypedCollection['carts']
-  /**
-   * The ID of the current cart corresponding to the cart in the database or local storage.
-   */
-  cartID?: DefaultDocumentIDType
-  /**
-   * Clear the cart, removing all items.
-   */
-  clearCart: () => Promise<void>
-  /**
-   * Initiate a payment using the selected payment method.
-   * This method should be called after the cart is ready for checkout.
-   * It requires the payment method ID and any necessary payment data.
-   */
-  confirmOrder: (
-    paymentMethodID: string,
-    options?: { additionalData: Record<string, unknown> },
-  ) => Promise<unknown>
-  /**
-   * Create a new address by providing the data.
-   */
-  createAddress: (data: Partial<TypedCollection['addresses']>) => Promise<void>
-  /**
-   * The configuration for the currencies used in the ecommerce context.
-   */
-  currenciesConfig: CurrenciesConfig
-  /**
-   * The currently selected currency used for the cart and price formatting automatically.
-   */
-  currency: Currency
-  /**
-   * Decrement an item in the cart by its index ID.
-   * If quantity reaches 0, the item will be removed from the cart.
-   */
-  decrementItem: (item: DefaultDocumentIDType) => Promise<void>
-  /**
-   * Increment an item in the cart by its index ID.
-   */
-  incrementItem: (item: DefaultDocumentIDType) => Promise<void>
-  /**
-   * Initiate a payment using the selected payment method.
-   * This method should be called after the cart is ready for checkout.
-   * It requires the payment method ID and any necessary payment data.
-   */
-  initiatePayment: (
-    paymentMethodID: string,
-    options?: { additionalData: Record<string, unknown> },
-  ) => Promise<unknown>
-  /**
-   *
-   */
-  paymentData?: Record<string, unknown>
-  paymentMethods: PaymentAdapterClient[]
-  /**
-   * Remove an item from the cart by its index ID.
-   */
-  removeItem: (item: DefaultDocumentIDType) => Promise<void>
-  /**
-   * The name of the currently selected payment method.
-   * This is used to determine which payment method to use when initiating a payment.
-   */
-  selectedPaymentMethod?: null | string
-  /**
-   * Change the currency for the cart, it defaults to the configured currency.
-   * This will update the currency used for pricing and calculations.
-   */
-  setCurrency: (currency: string) => void
-  /**
-   * Update an address by providing the data and the ID.
-   */
-  updateAddress: (
-    addressID: DefaultDocumentIDType,
-    data: Partial<TypedCollection['addresses']>,
-  ) => Promise<void>
-}

package/src/react/provider/utilities.ts

@@ -1,22 +0,0 @@
-import type { Currency } from '../../types.js'
-
-/**
- * Convert base value to display value with decimal point (e.g., 2500 to $25.00)
- */
-export const convertFromBaseValue = ({
-  baseValue,
-  currency,
-}: {
-  baseValue: number
-  currency: Currency
-}): string => {
-  if (!currency) {
-    return baseValue.toString()
-  }
-
-  // Convert from base value (e.g., cents) to decimal value (e.g., dollars)
-  const decimalValue = baseValue / Math.pow(10, currency.decimals)
-
-  // Format with the correct number of decimal places
-  return decimalValue.toFixed(currency.decimals)
-}

package/src/transactions/transactionsCollection.ts

@@ -1,166 +0,0 @@
-import type { CollectionConfig, Field } from 'payload'
-
-import type { CurrenciesConfig, FieldsOverride, PaymentAdapter } from '../types.js'
-
-import { amountField } from '../fields/amountField.js'
-import { cartItemsField } from '../fields/cartItemsField.js'
-import { currencyField } from '../fields/currencyField.js'
-import { statusField } from '../fields/statusField.js'
-
-type Props = {
-  /**
-   * Array of fields used for capturing the billing address.
-   */
-  addressFields?: Field[]
-  /**
-   * Slug of the carts collection, defaults to 'carts'.
-   */
-  cartsSlug?: string
-  currenciesConfig?: CurrenciesConfig
-  /**
-   * Slug of the customers collection, defaults to 'users'.
-   */
-  customersSlug?: string
-  /**
-   * Enable variants in the transactions collection.
-   */
-  enableVariants?: boolean
-  /**
-   * Slug of the orders collection, defaults to 'orders'.
-   */
-  ordersSlug?: string
-  overrides?: { fields?: FieldsOverride } & Partial<Omit<CollectionConfig, 'fields'>>
-  paymentMethods?: PaymentAdapter[]
-  /**
-   * Slug of the products collection, defaults to 'products'.
-   */
-  productsSlug?: string
-  /**
-   * Slug of the variants collection, defaults to 'variants'.
-   */
-  variantsSlug?: string
-}
-
-export const transactionsCollection: (props?: Props) => CollectionConfig = (props) => {
-  const {
-    addressFields,
-    cartsSlug = 'carts',
-    currenciesConfig,
-    customersSlug = 'users',
-    enableVariants = false,
-    ordersSlug = 'orders',
-    overrides,
-    paymentMethods,
-    productsSlug = 'products',
-    variantsSlug = 'variants',
-  } = props || {}
-
-  const fieldsOverride = overrides?.fields
-
-  const defaultFields: Field[] = [
-    {
-      name: 'customer',
-      type: 'relationship',
-      label: ({ t }) =>
-        // @ts-expect-error - translations are not typed in plugins yet
-        t('plugin-ecommerce:customer'),
-      relationTo: customersSlug,
-    },
-    {
-      name: 'customerEmail',
-      type: 'email',
-      label: ({ t }) =>
-        // @ts-expect-error - translations are not typed in plugins yet
-        t('plugin-ecommerce:customerEmail'),
-    },
-    {
-      name: 'order',
-      type: 'relationship',
-      label: ({ t }) =>
-        // @ts-expect-error - translations are not typed in plugins yet
-        t('plugin-ecommerce:order'),
-      relationTo: ordersSlug,
-    },
-    {
-      name: 'cart',
-      type: 'relationship',
-      relationTo: cartsSlug,
-    },
-    ...(addressFields
-      ? [
-          {
-            name: 'billingAddress',
-            type: 'group',
-            fields: addressFields,
-            label: ({ t }) =>
-              // @ts-expect-error - translations are not typed in plugins yet
-              t('plugin-ecommerce:shippingAddress'),
-          } as Field,
-        ]
-      : []),
-    cartItemsField({
-      enableVariants,
-      overrides: {
-        name: 'items',
-        label: ({ t }) =>
-          // @ts-expect-error - translations are not typed in plugins yet
-          t('plugin-ecommerce:items'),
-        labels: {
-          plural: ({ t }) =>
-            // @ts-expect-error - translations are not typed in plugins yet
-            t('plugin-ecommerce:items'),
-          singular: ({ t }) =>
-            // @ts-expect-error - translations are not typed in plugins yet
-            t('plugin-ecommerce:item'),
-        },
-      },
-      productsSlug,
-      variantsSlug,
-    }),
-    statusField(),
-  ]
-
-  if (paymentMethods?.length && paymentMethods.length > 0) {
-    defaultFields.push({
-      name: 'paymentMethod',
-      type: 'select',
-      label: ({ t }) =>
-        // @ts-expect-error - translations are not typed in plugins yet
-        t('plugin-ecommerce:paymentMethod'),
-      options: paymentMethods.map((method) => ({
-        label: method.label ?? method.name,
-        value: method.name,
-      })),
-    })
-
-    paymentMethods.forEach((method) => {
-      defaultFields.push(method.group)
-    })
-  }
-
-  if (currenciesConfig) {
-    defaultFields.push(currencyField({ currenciesConfig }))
-    defaultFields.push(amountField({ currenciesConfig }))
-  }
-
-  const fields =
-    fieldsOverride && typeof fieldsOverride === 'function'
-      ? fieldsOverride({ defaultFields })
-      : defaultFields
-
-  const baseConfig: CollectionConfig = {
-    slug: 'transactions',
-    ...overrides,
-    access: {
-      read: () => true,
-      ...(overrides?.access || []),
-    },
-    admin: {
-      defaultColumns: ['createdAt', 'customer', 'order', 'amount', 'status'],
-      ...overrides?.admin,
-    },
-    fields,
-  }
-
-  return { ...baseConfig }
-}

package/src/translations/en.ts

@@ -1,64 +0,0 @@
-import type { GenericTranslationsObject } from '@payloadcms/translations'
-
-export const en: GenericTranslationsObject = {
-  $schema: './translation-schema.json',
-  'plugin-ecommerce': {
-    abandoned: 'Abandoned',
-    addressCity: 'City',
-    addressCompany: 'Company',
-    addressCountry: 'Country',
-    addressFirstName: 'First name',
-    addressLastName: 'Last name',
-    addressLine1: 'Address 1',
-    addressLine2: 'Address 2',
-    addressPhone: 'Phone',
-    addressPostalCode: 'Postal code',
-    addressState: 'State',
-    addressTitle: 'Title',
-    amount: 'Amount',
-    availableVariants: 'Available variants',
-    billingAddress: 'Billing address',
-    cancelled: 'Cancelled',
-    cart: 'Cart',
-    completed: 'Completed',
-    currency: 'Currency',
-    customer: 'Customer',
-    customerEmail: 'Customer email',
-    customers: 'Customers',
-    enableCurrencyPrice: `Enable {{currency}} price`,
-    enableVariants: 'Enable variants',
-    expired: 'Expired',
-    failed: 'Failed',
-    inventory: 'Inventory',
-    item: 'Item',
-    items: 'Items',
-    open: 'Open',
-    order: 'Order',
-    paymentMethod: 'Payment method',
-    paymentMethods: 'Payment methods',
-    pending: 'Pending',
-    price: 'Price',
-    priceIn: 'Price ({{currency}})',
-    prices: 'Prices',
-    processing: 'Processing',
-    product: 'Product',
-    productRequired: 'A product is required.',
-    products: 'Products',
-    quantity: 'Quantity',
-    refunded: 'Refunded',
-    shippingAddress: 'Shipping address',
-    status: 'Status',
-    subtotal: 'Subtotal',
-    succeeded: 'Succeeded',
-    transactions: 'Transactions',
-    variant: 'Variant',
-    variantOptions: 'Variant options',
-    variantOptionsAlreadyExists:
-      'This variant combo is already in use by another variant. Please select different options.',
-    variantOptionsRequired: 'Variant options are required.',
-    variantOptionsRequiredAll: 'All variant options are required.',
-    variants: 'Variants',
-    variantType: 'Variant type',
-    variantTypes: 'Variant types',
-  },
-}

package/src/translations/index.ts

@@ -1,11 +0,0 @@
-import type { GenericTranslationsObject, NestedKeysStripped } from '@payloadcms/translations'
-
-import { en } from './en.js'
-
-export const translations = {
-  en,
-}
-
-export type EcommerceTranslations = GenericTranslationsObject
-
-export type EcommerceTranslationKeys = NestedKeysStripped<EcommerceTranslations>

package/src/translations/translation-schema.json

@@ -1,35 +0,0 @@
-{
-  "type": "object",
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "additionalProperties": false,
-  "properties": {
-    "$schema": {
-      "type": "string"
-    },
-    "ecommerce": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "variantOptionsAlreadyExists": {
-          "type": "string"
-        },
-        "productRquired": {
-          "type": "string"
-        },
-        "variantOptionsRequired": {
-          "type": "string"
-        },
-        "variantOptionsRequiredAll": {
-          "type": "string"
-        }
-      },
-      "required": [
-        "variantOptionsAlreadyExists",
-        "productRquired",
-        "variantOptionsRequired",
-        "variantOptionsRequiredAll"
-      ]
-    }
-  },
-  "required": ["ecommerce"]
-}