@payloadcms/storage-r2 0.0.1-beta.0

package/.prettierignore

@@ -0,0 +1,12 @@
+.tmp
+**/.git
+**/.hg
+**/.pnp.*
+**/.svn
+**/.yarn/**
+**/build
+**/dist/**
+**/node_modules
+**/temp
+**/docs/**
+tsconfig.json

package/.swcrc

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/swcrc",
+  "sourceMaps": true,
+  "jsc": {
+    "target": "esnext",
+    "parser": {
+      "syntax": "typescript",
+      "tsx": true,
+      "dts": true
+    },
+    "transform": {
+      "react": {
+        "runtime": "automatic",
+        "pragmaFrag": "React.Fragment",
+        "throwIfNamespace": true,
+        "development": false,
+        "useBuiltins": true
+      }
+    }
+  },
+  "module": {
+    "type": "es6"
+  }
+}

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018-2025 Payload CMS, Inc. <info@payloadcms.com>
+
+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,3 @@
+# Payload Ecommerce
+
+A set of utilities... more to come

package/eslint.config.js

@@ -0,0 +1,18 @@
+import { rootEslintConfig, rootParserOptions } from '../../eslint.config.js'
+
+/** @typedef {import('eslint').Linter.Config} Config */
+
+/** @type {Config[]} */
+export const index = [
+  ...rootEslintConfig,
+  {
+    languageOptions: {
+      parserOptions: {
+        ...rootParserOptions,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+]
+
+export default index

package/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@payloadcms/storage-r2",
+  "version": "0.0.1-beta.0"
+}

package/src/addresses/addressesCollection.ts

@@ -0,0 +1,76 @@
+import type { CollectionConfig, Field } from 'payload'
+
+import type { CountryType, FieldsOverride } from '../types.js'
+
+import { defaultCountries } from './defaultCountries.js'
+
+type Props = {
+  /**
+   * Array of fields used for capturing the address data. Use this over overrides to customise the fields here as it's reused across the plugin.
+   */
+  addressFields: Field[]
+  /**
+   * Slug of the customers collection, defaults to 'users'.
+   */
+  customersSlug?: string
+  overrides?: { fields?: FieldsOverride } & Partial<Omit<CollectionConfig, 'fields'>>
+  supportedCountries?: CountryType[]
+}
+
+export const addressesCollection: (props: Props) => CollectionConfig = (props) => {
+  const { addressFields, customersSlug = 'users', overrides } = props || {}
+  const fieldsOverride = overrides?.fields
+
+  const { supportedCountries: supportedCountriesFromProps } = props || {}
+  const supportedCountries = supportedCountriesFromProps || defaultCountries
+  const hasOnlyOneCountry = supportedCountries && supportedCountries.length === 1
+
+  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,
+    },
+    ...addressFields.map((field) => {
+      if ('name' in field && field.name === 'country') {
+        return {
+          name: 'country',
+          type: 'select',
+          label: ({ t }) =>
+            // @ts-expect-error - translations are not typed in plugins yet
+            t('plugin-ecommerce:addressCountry'),
+          options: supportedCountries || defaultCountries,
+          required: true,
+          ...(supportedCountries && supportedCountries?.[0] && hasOnlyOneCountry
+            ? {
+                defaultValue: supportedCountries?.[0].value,
+              }
+            : {}),
+        } as Field
+      }
+
+      return field
+    }),
+  ]
+
+  const fields =
+    fieldsOverride && typeof fieldsOverride === 'function'
+      ? fieldsOverride({ defaultFields })
+      : defaultFields
+
+  const baseConfig: CollectionConfig = {
+    slug: 'addresses',
+    timestamps: true,
+    ...overrides,
+    admin: {
+      useAsTitle: 'createdAt',
+      ...overrides?.admin,
+    },
+    fields,
+  }
+
+  return { ...baseConfig }
+}

package/src/addresses/defaultAddressFields.ts

@@ -0,0 +1,83 @@
+import type { Field } from 'payload'
+
+export const defaultAddressFields: () => Field[] = () => {
+  return [
+    {
+      name: 'title',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressTitle'),
+    },
+    {
+      name: 'firstName',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressFirstName'),
+    },
+    {
+      name: 'lastName',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressLastName'),
+    },
+    {
+      name: 'company',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressCompany'),
+    },
+    {
+      name: 'addressLine1',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressLine1'),
+    },
+    {
+      name: 'addressLine2',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressLine2'),
+    },
+    {
+      name: 'city',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressCity'),
+    },
+    {
+      name: 'state',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressState'),
+    },
+    {
+      name: 'postalCode',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressPostalCode'),
+    },
+    {
+      name: 'country',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressCountry'),
+    },
+    {
+      name: 'phone',
+      type: 'text',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:addressPhone'),
+    },
+  ]
+}

package/src/addresses/defaultCountries.ts

@@ -0,0 +1,50 @@
+import type { CountryType } from '../types.js'
+
+/**
+ * Default list of countries supported for forms and payments.
+ * This can be overriden or reused in other parts of the application.
+ *
+ * The label is the human-readable name of the country, and the value is the ISO 3166-1 alpha-2 code.
+ */
+export const defaultCountries: CountryType[] = [
+  { label: 'United States', value: 'US' },
+  { label: 'United Kingdom', value: 'GB' },
+  { label: 'Canada', value: 'CA' },
+  { label: 'Australia', value: 'AU' },
+  { label: 'Austria', value: 'AT' },
+  { label: 'Belgium', value: 'BE' },
+  { label: 'Brazil', value: 'BR' },
+  { label: 'Bulgaria', value: 'BG' },
+  { label: 'Cyprus', value: 'CY' },
+  { label: 'Czech Republic', value: 'CZ' },
+  { label: 'Denmark', value: 'DK' },
+  { label: 'Estonia', value: 'EE' },
+  { label: 'Finland', value: 'FI' },
+  { label: 'France', value: 'FR' },
+  { label: 'Germany', value: 'DE' },
+  { label: 'Greece', value: 'GR' },
+  { label: 'Hong Kong', value: 'HK' },
+  { label: 'Hungary', value: 'HU' },
+  { label: 'India', value: 'IN' },
+  { label: 'Ireland', value: 'IE' },
+  { label: 'Italy', value: 'IT' },
+  { label: 'Japan', value: 'JP' },
+  { label: 'Latvia', value: 'LV' },
+  { label: 'Lithuania', value: 'LT' },
+  { label: 'Luxembourg', value: 'LU' },
+  { label: 'Malaysia', value: 'MY' },
+  { label: 'Malta', value: 'MT' },
+  { label: 'Mexico', value: 'MX' },
+  { label: 'Netherlands', value: 'NL' },
+  { label: 'New Zealand', value: 'NZ' },
+  { label: 'Norway', value: 'NO' },
+  { label: 'Poland', value: 'PL' },
+  { label: 'Portugal', value: 'PT' },
+  { label: 'Romania', value: 'RO' },
+  { label: 'Singapore', value: 'SG' },
+  { label: 'Slovakia', value: 'SK' },
+  { label: 'Slovenia', value: 'SI' },
+  { label: 'Spain', value: 'ES' },
+  { label: 'Sweden', value: 'SE' },
+  { label: 'Switzerland', value: 'CH' },
+]

package/src/carts/beforeChange.ts

@@ -0,0 +1,51 @@
+import type { CollectionBeforeChangeHook } from 'payload'
+
+type Props = {
+  productsSlug: string
+  variantsSlug: string
+}
+
+export const beforeChangeCart: (args: Props) => CollectionBeforeChangeHook =
+  ({ productsSlug, variantsSlug }) =>
+  async ({ data, req }) => {
+    // Update subtotal based on items in the cart
+    if (data.items && Array.isArray(data.items)) {
+      const priceField = `priceIn${data.currency}`
+
+      let subtotal = 0
+
+      for (const item of data.items) {
+        if (item.variant) {
+          const id = typeof item.variant === 'object' ? item.variant.id : item.variant
+
+          const variant = await req.payload.findByID({
+            id,
+            collection: variantsSlug,
+            depth: 0,
+            select: {
+              [priceField]: true,
+            },
+          })
+
+          subtotal += variant[priceField] * item.quantity
+        } else {
+          const id = typeof item.product === 'object' ? item.product.id : item.product
+
+          const product = await req.payload.findByID({
+            id,
+            collection: productsSlug,
+            depth: 0,
+            select: {
+              [priceField]: true,
+            },
+          })
+
+          subtotal += product[priceField] * item.quantity
+        }
+      }
+
+      data.subtotal = subtotal
+    } else {
+      data.subtotal = 0
+    }
+  }

package/src/carts/cartsCollection.ts

@@ -0,0 +1,146 @@
+import type { CollectionConfig, Field } from 'payload'
+
+import type { CurrenciesConfig, FieldsOverride } from '../types.js'
+
+import { amountField } from '../fields/amountField.js'
+import { cartItemsField } from '../fields/cartItemsField.js'
+import { currencyField } from '../fields/currencyField.js'
+import { beforeChangeCart } from './beforeChange.js'
+
+type Props = {
+  currenciesConfig?: CurrenciesConfig
+  /**
+   * Slug of the customers collection, defaults to 'users'.
+   */
+  customersSlug?: string
+  /**
+   * Enables support for variants in the cart.
+   * Defaults to false.
+   */
+  enableVariants?: boolean
+  overrides?: { fields?: FieldsOverride } & Partial<Omit<CollectionConfig, 'fields'>>
+  /**
+   * Slug of the products collection, defaults to 'products'.
+   */
+  productsSlug?: string
+  /**
+   * Slug of the variants collection, defaults to 'variants'.
+   */
+  variantsSlug?: string
+}
+
+export const cartsCollection: (props?: Props) => CollectionConfig = (props) => {
+  const {
+    currenciesConfig,
+    customersSlug = 'users',
+    enableVariants = false,
+    overrides,
+    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: 'purchasedAt',
+      type: 'date',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:purchasedAt'),
+    },
+    {
+      name: 'status',
+      type: 'select',
+      defaultValue: 'open',
+      interfaceName: 'CartStatus',
+      label: ({ t }) =>
+        // @ts-expect-error - translations are not typed in plugins yet
+        t('plugin-ecommerce:status'),
+      options: [
+        {
+          // @ts-expect-error - translations are not typed in plugins yet
+          label: ({ t }) => t('plugin-ecommerce:open'),
+          value: 'open',
+        },
+        {
+          // @ts-expect-error - translations are not typed in plugins yet
+          label: ({ t }) => t('plugin-ecommerce:abandoned'),
+          value: 'abandoned',
+        },
+        {
+          // @ts-expect-error - translations are not typed in plugins yet
+          label: ({ t }) => t('plugin-ecommerce:completed'),
+          value: 'completed',
+        },
+      ],
+    },
+    ...(currenciesConfig
+      ? [
+          currencyField({
+            currenciesConfig,
+          }),
+          amountField({
+            currenciesConfig,
+            overrides: {
+              name: 'subtotal',
+              label: ({ t }) =>
+                // @ts-expect-error - translations are not typed in plugins yet
+                t('plugin-ecommerce:subtotal'),
+            },
+          }),
+        ]
+      : []),
+    cartItemsField({
+      enableVariants,
+      overrides: {
+        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,
+    }),
+  ]
+
+  const fields =
+    fieldsOverride && typeof fieldsOverride === 'function'
+      ? fieldsOverride({ defaultFields })
+      : defaultFields
+
+  const baseConfig: CollectionConfig = {
+    slug: 'carts',
+    timestamps: true,
+    ...overrides,
+    admin: {
+      useAsTitle: 'createdAt',
+      ...overrides?.admin,
+    },
+    fields,
+    hooks: {
+      beforeChange: [
+        // This hook can be used to update the subtotal before saving the cart
+        beforeChangeCart({ productsSlug, variantsSlug }),
+        ...(overrides?.hooks?.beforeChange || []),
+      ],
+      ...overrides?.hooks,
+    },
+  }
+
+  return { ...baseConfig }
+}

package/src/currencies/index.ts

@@ -0,0 +1,29 @@
+import type { Currency } from '../types.js'
+
+export const EUR: Currency = {
+  code: 'EUR',
+  decimals: 2,
+  label: 'Euro',
+  symbol: '€',
+}
+
+export const USD: Currency = {
+  code: 'USD',
+  decimals: 2,
+  label: 'US Dollar',
+  symbol: '$',
+}
+
+export const GBP: Currency = {
+  code: 'GBP',
+  decimals: 2,
+  label: 'British Pound',
+  symbol: '£',
+}
+
+export const JPY: Currency = {
+  code: 'JPY',
+  decimals: 0,
+  label: 'Japanese Yen',
+  symbol: '¥',
+}