Getting fields' config in beforeChange collection hook | Payload | Page 1

lavish urchin Apr 5, 2023, 3:55 AM

#

The data argument of the beforeChange collection hook looks like this:

{
  slug: 'slug-in-german',
  title: 'Title in German',
  excerpt: 'The excerpt goes here.',
  _status: 'draft',
}

I'd like to get the config of each of these fields (ultimately to know whether or not the field is localized: true or not).

I went in and used req.payload.config.collections, filtered it to get the current collection, and started parsing that to try and reduce it to something that would look like this:

{
  slug: false,
  title: true, 
  excerpt: true,
  _status: false,
}

But once you start adding Tabs and Groups and Arrays and Blocks and ... into the mix, it start getting a little hairy and feeling grosser and grosser. 😅

There's got to be a better way, right? 👀 🤔

brave galleon Apr 5, 2023, 5:31 AM

#

lavish urchin The `data` argument of the `beforeChange` collection hook looks like this: ```ja...

Or I wonder if the buildStateFromSchema function might do it for you!

#

Try passing in the fields array into buildStateFromSchema and see what happens

lavish urchin Apr 5, 2023, 6:43 AM

#

Oooh you got me excited, let me give that a go! 👀

lavish urchin Apr 5, 2023, 7:04 AM

#

Hmmm doesn't seem to be quite what I need, this is what buildStateFromSchema returns:

{
  title: {
    valid: true,
    value: 'Title in German',
    initialValue: 'Title in German',
    validate: [Function (anonymous)],
    condition: undefined,
    passesCondition: true
  },
  slug: {
    valid: true,
    value: 'slug-in-german',
    initialValue: 'slug-in-german',
    validate: [Function (anonymous)],
    condition: undefined,
    passesCondition: true
  },
  ...
}

brave galleon Apr 5, 2023, 7:16 AM

#

hm

#

what about reduceFieldsToValues?

#

or wait

#

the main problem is parsing more complex blocks isn't it?

#

e.g. blocks with subfields?

neat roost Apr 5, 2023, 7:22 AM

#

You could always just import your collection config directly

#

But again, you would probably need to still handle nested fields

brave galleon Apr 5, 2023, 7:23 AM

#

neat roost You could always just import your collection config directly

wouldn't that result in the same data compared to using req.payload.config.collections?

neat roost Apr 5, 2023, 7:24 AM

#

Likely, but you could skip the faff of filtering from the collections array if you want to get the config of a specific static collection

lavish urchin Apr 5, 2023, 7:39 AM

#

Yeah getting the full config is pretty straightforward here one way or the other, the tricky part is mapping the data to their associated field config... 🤔

neat roost Apr 5, 2023, 7:44 AM

#

You might have to make a recursive parser to get the output you specifically want

lavish urchin Apr 5, 2023, 7:44 AM

#

Another to approach the problem I have could be to find a way to emulate the afterChange state of the doc with locale: "all".

For example, following my initial example, if I could get:

{
  id: '642609c1a7d2bc624df538da',
  title: { 
    en: 'Title in English', 
    de: 'Title in German' 
  },
  slug: { 
    en: 'slug-in-english', 
    de: 'slug-in-german' 
  },
  excerpt: { 
    de: 'The excerpt goes here.' 
  },
  _status: 'draft',
  createdAt: '2023-03-30T22:14:25.318Z',
  updatedAt: '2023-04-05T07:02:50.800Z'
}

ie: findByID result + the current operation's data, I'd be golden. 🙌

I may have to do more digging into how Payload work on the inside. 😅

lavish urchin Apr 5, 2023, 7:47 AM

#

neat roost You might have to make a recursive parser to get the output you specifically wan...

Yeah that's what I started doing and it quickly started feeling a bit "gross". And given that Payload probably already do this somehow somewhere, I figured that I probably shouldn't be reinventing the wheel and that maybe someone would know where the magic happens within Payload - and how to utilize it. 😊

lavish urchin Apr 6, 2023, 1:02 AM

#

Haven't had the chance to dig more into this yet today, but giving it a bump in case anyone who knows how Payload works on the inside happens to be around and has thoughts. 🙏

timber stream Apr 11, 2023, 5:08 PM

#

I think the recursive parser is a fine approach, you would just separate your parsing functions into field types and loop over the a collection config and generate this obj/map

What are you trying to achieve, would a fieldHook work better for you? https://payloadcms.com/docs/hooks/fields

#Getting fields' config in beforeChange collection hook