payload 1.15.9 → 1.15.10

package/templates/ecommerce/src/payload/collections/Users/checkRole.ts

@@ -1,16 +0,0 @@
-import type { User } from '../../payload-types'
-
-export const checkRole = (allRoles: User['roles'] = [], user?: User): boolean => {
-  if (user) {
-    if (
-      allRoles.some(role => {
-        return user?.roles?.some(individualRole => {
-          return individualRole === role
-        })
-      })
-    )
-      return true
-  }
-
-  return false
-}

package/templates/ecommerce/src/payload/collections/Users/endpoints/customer.ts

@@ -1,79 +0,0 @@
-import type { PayloadHandler } from 'payload/config'
-import type { PayloadRequest } from 'payload/types'
-import Stripe from 'stripe'
-
-const stripe = new Stripe(process.env.STRIPE_SECRET_KEY, {
-  apiVersion: '2022-08-01',
-})
-
-const logs = process.env.LOGS_STRIPE_PROXY === '1'
-
-// use this handler to interact with a Stripe customer associated with any given user
-// does so in secure way that does not leak or expose any cross-customer data
-// pass the proper method and body to this endpoint to interact with the Stripe API
-// available methods:
-// GET /api/users/:id/customer
-// POST /api/users/:id/customer
-// body: { customer: Stripe.CustomerUpdateParams }
-export const customerProxy: PayloadHandler = async (req: PayloadRequest, res) => {
-  const { userID } = req.params
-
-  if (!req.user) {
-    if (logs) req.payload.logger.error({ err: `You are not authorized to access this customer` })
-    res.status(401).json({ error: 'You are not authorized to access this customer' })
-    return
-  }
-
-  if (!req.user?.stripeCustomerID) {
-    const message = `No stripeCustomerID found for user ${userID}`
-    if (logs) req.payload.logger.error({ err: message })
-    res.status(401).json({ error: message })
-    return
-  }
-
-  try {
-    let response:
-      | Stripe.Customer
-      | Stripe.DeletedCustomer
-      | Array<Stripe.Customer | Stripe.DeletedCustomer>
-      | Stripe.ApiList<Stripe.Customer | Stripe.DeletedCustomer>
-
-    let customer: Stripe.Customer | Stripe.DeletedCustomer | null = null
-
-    if (req.user.stripeCustomerID) {
-      // look up the customer to ensure that it belongs to the user
-      // this will ensure that this user is allows perform operations on it
-      customer = await stripe.customers.retrieve(req.user.stripeCustomerID, {
-        expand: ['invoice_settings.default_payment_method'],
-      })
-
-      if (customer.deleted) {
-        res.status(404).json({ error: `Customer ${req.user.stripeCustomerID} not found` })
-        return
-      }
-
-      // ensure the customer belongs to the user
-      if (customer.id !== req.user.stripeCustomerID) {
-        res.status(401).json({ error: `You are not authorized to access this customer` })
-        return
-      }
-    }
-
-    if (req.method === 'GET') {
-      if (req.user.stripeCustomerID) {
-        response = customer
-      }
-    }
-
-    if (req.method === 'PATCH') {
-      if (!req.body) throw new Error('No customer data provided')
-      // TODO: lock down the spread `customer` object to only allow certain fields
-      response = await stripe.customers.update(req.user.stripeCustomerID, req.body)
-    }
-
-    res.status(200).json(response)
-  } catch (error: unknown) {
-    if (logs) req.payload.logger.error({ err: `Error using Stripe API: ${error}` })
-    res.status(500).json({ error: `Error using Stripe API: ${error}` })
-  }
-}

package/templates/ecommerce/src/payload/collections/Users/hooks/createStripeCustomer.ts

@@ -1,41 +0,0 @@
-import type { BeforeChangeHook } from 'payload/dist/collections/config/types'
-import Stripe from 'stripe'
-
-const stripe = new Stripe(process.env.STRIPE_SECRET_KEY || '', {
-  apiVersion: '2022-08-01',
-})
-
-export const createStripeCustomer: BeforeChangeHook = async ({ req, data, operation }) => {
-  if (operation === 'create' && !data.stripeCustomerID) {
-    try {
-      // lookup an existing customer by email and if found, assign the ID to the user
-      // if not found, create a new customer and assign the new ID to the user
-      const existingCustomer = await stripe.customers.list({
-        limit: 1,
-        email: data.email,
-      })
-
-      if (existingCustomer.data.length) {
-        // existing customer found, assign the ID to the user
-        return {
-          ...data,
-          stripeCustomerID: existingCustomer.data[0].id,
-        }
-      }
-
-      // create a new customer and assign the ID to the user
-      const customer = await stripe.customers.create({
-        email: data.email,
-      })
-
-      return {
-        ...data,
-        stripeCustomerID: customer.id,
-      }
-    } catch (error: unknown) {
-      req.payload.logger.error(`Error creating Stripe customer: ${error}`)
-    }
-  }
-
-  return data
-}

package/templates/ecommerce/src/payload/collections/Users/hooks/ensureFirstUserIsAdmin.ts

@@ -1,22 +0,0 @@
-import type { FieldHook } from 'payload/types'
-
-import type { User } from '../../../payload-types'
-
-// ensure the first user created is an admin
-// 1. lookup a single user on create as succinctly as possible
-// 2. if there are no users found, append `admin` to the roles array
-// access control is already handled by this fields `access` property
-// it ensures that only admins can create and update the `roles` field
-export const ensureFirstUserIsAdmin: FieldHook<User> = async ({ req, operation, value }) => {
-  if (operation === 'create') {
-    const users = await req.payload.find({ collection: 'users', limit: 0, depth: 0 })
-    if (users.totalDocs === 0) {
-      // if `admin` not in array of values, add it
-      if (!(value || []).includes('admin')) {
-        return [...(value || []), 'admin']
-      }
-    }
-  }
-
-  return value
-}

package/templates/ecommerce/src/payload/collections/Users/hooks/loginAfterCreate.ts

@@ -1,29 +0,0 @@
-import type { AfterChangeHook } from 'payload/dist/collections/config/types'
-
-export const loginAfterCreate: AfterChangeHook = async ({
-  doc,
-  req,
-  req: { payload, body = {}, res },
-  operation,
-}) => {
-  if (operation === 'create' && !req.user) {
-    const { email, password } = body
-
-    if (email && password) {
-      const { user, token } = await payload.login({
-        collection: 'users',
-        data: { email, password },
-        req,
-        res,
-      })
-
-      return {
-        ...doc,
-        token,
-        user,
-      }
-    }
-  }
-
-  return doc
-}

package/templates/ecommerce/src/payload/collections/Users/hooks/resolveDuplicatePurchases.ts

@@ -1,15 +0,0 @@
-import type { FieldHook } from 'payload/types'
-
-import type { User } from '../../../payload-types'
-
-export const resolveDuplicatePurchases: FieldHook<User> = async ({ value, operation }) => {
-  if ((operation === 'create' || operation === 'update') && value) {
-    return Array.from(
-      new Set(
-        value?.map(purchase => (typeof purchase === 'string' ? purchase : purchase.id)) || [],
-      ),
-    )
-  }
-
-  return
-}

package/templates/ecommerce/src/payload/collections/Users/index.ts

@@ -1,158 +0,0 @@
-import type { CollectionConfig } from 'payload/types'
-
-import { admins } from '../../access/admins'
-import { anyone } from '../../access/anyone'
-import adminsAndUser from './access/adminsAndUser'
-import { checkRole } from './checkRole'
-import { customerProxy } from './endpoints/customer'
-import { createStripeCustomer } from './hooks/createStripeCustomer'
-import { ensureFirstUserIsAdmin } from './hooks/ensureFirstUserIsAdmin'
-import { loginAfterCreate } from './hooks/loginAfterCreate'
-import { resolveDuplicatePurchases } from './hooks/resolveDuplicatePurchases'
-import { CustomerSelect } from './ui/CustomerSelect'
-
-const Users: CollectionConfig = {
-  slug: 'users',
-  admin: {
-    useAsTitle: 'name',
-    defaultColumns: ['name', 'email'],
-  },
-  access: {
-    read: adminsAndUser,
-    create: anyone,
-    update: adminsAndUser,
-    delete: admins,
-    admin: ({ req: { user } }) => checkRole(['admin'], user),
-  },
-  hooks: {
-    beforeChange: [createStripeCustomer],
-    afterChange: [loginAfterCreate],
-  },
-  auth: true,
-  endpoints: [
-    {
-      path: '/:teamID/customer',
-      method: 'get',
-      handler: customerProxy,
-    },
-    {
-      path: '/:teamID/customer',
-      method: 'patch',
-      handler: customerProxy,
-    },
-  ],
-  fields: [
-    {
-      name: 'name',
-      type: 'text',
-    },
-    {
-      name: 'roles',
-      type: 'select',
-      hasMany: true,
-      defaultValue: ['customer'],
-      options: [
-        {
-          label: 'admin',
-          value: 'admin',
-        },
-        {
-          label: 'customer',
-          value: 'customer',
-        },
-      ],
-      hooks: {
-        beforeChange: [ensureFirstUserIsAdmin],
-      },
-      access: {
-        read: admins,
-        create: admins,
-        update: admins,
-      },
-    },
-    {
-      name: 'purchases',
-      label: 'Purchases',
-      type: 'relationship',
-      relationTo: 'products',
-      hasMany: true,
-      hooks: {
-        beforeChange: [resolveDuplicatePurchases],
-      },
-    },
-    {
-      name: 'stripeCustomerID',
-      label: 'Stripe Customer',
-      type: 'text',
-      access: {
-        read: ({ req: { user } }) => checkRole(['admin'], user),
-      },
-      admin: {
-        position: 'sidebar',
-        components: {
-          Field: CustomerSelect,
-        },
-      },
-    },
-    {
-      label: 'Cart',
-      name: 'cart',
-      type: 'group',
-      fields: [
-        {
-          name: 'items',
-          label: 'Items',
-          type: 'array',
-          interfaceName: 'CartItems',
-          fields: [
-            {
-              name: 'product',
-              type: 'relationship',
-              relationTo: 'products',
-            },
-            {
-              name: 'quantity',
-              type: 'number',
-              min: 0,
-              admin: {
-                step: 1,
-              },
-            },
-          ],
-        },
-        // If you wanted to maintain a 'created on'
-        // or 'last modified' date for the cart
-        // you could do so here:
-        // {
-        //   name: 'createdOn',
-        //   label: 'Created On',
-        //   type: 'date',
-        //   admin: {
-        //     readOnly: true
-        //   }
-        // },
-        // {
-        //   name: 'lastModified',
-        //   label: 'Last Modified',
-        //   type: 'date',
-        //   admin: {
-        //     readOnly: true
-        //   }
-        // },
-      ],
-    },
-    {
-      name: 'skipSync',
-      label: 'Skip Sync',
-      type: 'checkbox',
-      admin: {
-        position: 'sidebar',
-        readOnly: true,
-        hidden: true,
-      },
-    },
-  ],
-  timestamps: true,
-}
-
-export default Users

package/templates/ecommerce/src/payload/collections/Users/ui/CustomerSelect.tsx

@@ -1,118 +0,0 @@
-import * as React from 'react'
-import { Select, useFormFields } from 'payload/components/forms'
-import CopyToClipboard from 'payload/dist/admin/components/elements/CopyToClipboard'
-import { TextField } from 'payload/dist/fields/config/types'
-
-export const CustomerSelect: React.FC<TextField> = props => {
-  const { name, label } = props
-  const [options, setOptions] = React.useState<
-    {
-      label: string
-      value: string
-    }[]
-  >([])
-
-  const { value: stripeCustomerID } = useFormFields(([fields]) => fields[name]) || {}
-
-  React.useEffect(() => {
-    const getStripeCustomers = async () => {
-      try {
-        const customersFetch = await fetch(`/api/stripe/customers`, {
-          credentials: 'include',
-          headers: {
-            'Content-Type': 'application/json',
-          },
-        })
-
-        const res = await customersFetch.json()
-
-        if (res?.data) {
-          const fetchedCustomers = res.data.reduce(
-            (acc, item) => {
-              acc.push({
-                label: item.name || item.email || item.id,
-                value: item.id,
-              })
-              return acc
-            },
-            [
-              {
-                label: 'Select a customer',
-                value: '',
-              },
-            ],
-          )
-          setOptions(fetchedCustomers)
-        }
-      } catch (error) {
-        console.error(error) // eslint-disable-line no-console
-      }
-    }
-
-    getStripeCustomers()
-  }, [])
-
-  const href = `https://dashboard.stripe.com/${
-    process.env.PAYLOAD_PUBLIC_STRIPE_IS_TEST_KEY ? 'test/' : ''
-  }customers/${stripeCustomerID}`
-
-  return (
-    <div>
-      <p style={{ marginBottom: '0' }}>{typeof label === 'string' ? label : 'Customer'}</p>
-      <p
-        style={{
-          marginBottom: '0.75rem',
-          color: 'var(--theme-elevation-400)',
-        }}
-      >
-        {`Select the related Stripe customer or `}
-        <a
-          href={`https://dashboard.stripe.com/${
-            process.env.PAYLOAD_PUBLIC_STRIPE_IS_TEST_KEY ? 'test/' : ''
-          }customers/create`}
-          target="_blank"
-          rel="noopener noreferrer"
-          style={{ color: 'var(--theme-text' }}
-        >
-          create a new one
-        </a>
-        {'.'}
-      </p>
-      <Select {...props} label="" options={options} />
-      {Boolean(stripeCustomerID) && (
-        <div>
-          <div>
-            <span
-              className="label"
-              style={{
-                color: '#9A9A9A',
-              }}
-            >
-              {`Manage "${
-                options.find(option => option.value === stripeCustomerID)?.label || 'Unknown'
-              }" in Stripe`}
-            </span>
-            <CopyToClipboard value={href} />
-          </div>
-          <div
-            style={{
-              overflow: 'hidden',
-              textOverflow: 'ellipsis',
-              fontWeight: '600',
-            }}
-          >
-            <a
-              href={`https://dashboard.stripe.com/${
-                process.env.PAYLOAD_PUBLIC_STRIPE_IS_TEST_KEY ? 'test/' : ''
-              }customers/${stripeCustomerID}`}
-              target="_blank"
-              rel="noreferrer noopener"
-            >
-              {href}
-            </a>
-          </div>
-        </div>
-      )}
-    </div>
-  )
-}

package/templates/ecommerce/src/payload/components/BeforeDashboard/SeedButton/index.tsx

@@ -1,40 +0,0 @@
-import React, { Fragment, useCallback, useState } from 'react'
-
-export const SeedButton: React.FC = () => {
-  const [loading, setLoading] = useState(false)
-  const [seeded, setSeeded] = useState(false)
-  const [error, setError] = useState(null)
-
-  const handleClick = useCallback(
-    async e => {
-      e.preventDefault()
-      if (loading || seeded) return
-
-      setLoading(true)
-
-      setTimeout(async () => {
-        try {
-          await fetch('/api/seed')
-          setSeeded(true)
-        } catch (err) {
-          setError(err)
-        }
-      }, 1000)
-    },
-    [loading, seeded],
-  )
-
-  let message = ''
-  if (loading) message = ' (seeding...)'
-  if (seeded) message = ' (done!)'
-  if (error) message = ` (error: ${error})`
-
-  return (
-    <Fragment>
-      <a href="/api/seed" target="_blank" rel="noopener noreferrer" onClick={handleClick}>
-        Seed your database
-      </a>
-      {message}
-    </Fragment>
-  )
-}

package/templates/ecommerce/src/payload/components/BeforeDashboard/index.scss

@@ -1,24 +0,0 @@
-@import '~payload/scss';
-
-.dashboard .before-dashboard {
-	margin-bottom: base(1.5);
-
-	&__banner {
-		& h4 {
-			margin: 0;
-		}
-	}
-
-	&__instructions {
-		list-style: decimal;
-		margin-bottom: base(0.5);
-
-		& li {
-			width: 100%;
-		}
-	}
-
-	& a:hover {
-		opacity: 0.85;
-	}
-}

package/templates/ecommerce/src/payload/components/BeforeDashboard/index.tsx

@@ -1,100 +0,0 @@
-import React from 'react'
-import { Link } from 'react-router-dom'
-import { Banner } from 'payload/components'
-
-import { SeedButton } from './SeedButton'
-
-import './index.scss'
-
-const baseClass = 'before-dashboard'
-
-const BeforeDashboard: React.FC = () => {
-  return (
-    <div className={baseClass}>
-      <Banner className={`${baseClass}__banner`} type="success">
-        <h4>Welcome to your dashboard!</h4>
-      </Banner>
-      Here&apos;s what to do next:
-      <ul className={`${baseClass}__instructions`}>
-        <li>
-          <SeedButton />
-          {' with a few products and pages to jump-start your new project, then '}
-          <a href="/">visit your website</a>
-          {' to see the results.'}
-        </li>
-        <li>
-          {'Head over to '}
-          <a
-            href="https://dashboard.stripe.com/test/apikeys"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            {'Stripe to obtain your API Keys'}
-          </a>
-          {
-            '. Create a new account if needed, then copy them into your environment variables and restart your server. See the '
-          }
-          <a
-            href="https://github.com/payloadcms/payload/blob/master/templates/ecommerce/README.md#stripe"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            {'README'}
-          </a>
-          {' for more details.'}
-        </li>
-        <li>
-          <Link to="/admin/collections/products">Link each of your products</Link>
-          {' to Stripe by selecting the corresponding product using the dropdown under '}
-          <i>Product Details</i>.
-        </li>
-        <li>
-          If you created this repo using Payload Cloud, head over to GitHub and clone it to your
-          local machine. It will be under the <i>GitHub Scope</i> that you selected when creating
-          this project.
-        </li>
-        <li>
-          {'Modify your '}
-          <a
-            href="https://payloadcms.com/docs/configuration/collections"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            collections
-          </a>
-          {' and add more '}
-          <a
-            href="https://payloadcms.com/docs/fields/overview"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            fields
-          </a>
-          {' as needed. If you are new to Payload, we also recommend you check out the '}
-          <a
-            href="https://payloadcms.com/docs/getting-started/what-is-payload"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            Getting Started
-          </a>
-          {' docs.'}
-        </li>
-        <li>
-          Commit and push your changes to the repository to trigger a redeployment of your project.
-        </li>
-      </ul>
-      {'Pro Tip: This block is a '}
-      <a
-        href={'https://payloadcms.com/docs/admin/components#base-component-overrides'}
-        target="_blank"
-        rel="noopener noreferrer"
-      >
-        custom component
-      </a>
-      , you can remove it at any time by updating your <strong>payload.config</strong>.
-    </div>
-  )
-}
-
-export default BeforeDashboard

package/templates/ecommerce/src/payload/components/BeforeLogin/index.tsx

@@ -1,16 +0,0 @@
-import React from 'react'
-
-const BeforeLogin: React.FC = () => {
-  return (
-    <div>
-      <p>
-        <b>Welcome to your dashboard!</b>
-        {' This is where site admins will log in to manage your store. Customers will need to '}
-        <a href={`${process.env.PAYLOAD_PUBLIC_SERVER_URL}/login`}>log in to the site instead</a>
-        {' to access their user account, order history, and more.'}
-      </p>
-    </div>
-  )
-}
-
-export default BeforeLogin

package/templates/ecommerce/src/payload/emptyModuleMock.js

@@ -1,4 +0,0 @@
-module.exports = {
-  url: () => {},
-  raw: () => {},
-}