feat: add timezone support on date fields

[paulpopus]

Adds support for timezone selection on date fields.

Summary

New admin.timezones config:

{
  // ...
  admin: {
    // ...
    timezones: {
      supportedTimezones: ({ defaultTimezones }) => [
        ...defaultTimezones,
        { label: '(GMT-6) Monterrey, Nuevo Leon', value: 'America/Monterrey' },
      ],
      defaultTimezone: 'America/Monterrey',
    },
  }
}

New timezone property on date fields:

{
  type: 'date',
  name: 'date',
  timezone: true,
}

Configuration

All date fields now accept timezone: true to enable this feature, which will inject a new field into the configuration using the date field's name to construct the name for the timezone column. So publishingDate will have publishingDate_tz as an accompanying column. This new field is inserted during config sanitisation.

Dates continue to be stored in UTC, this will help maintain dates without needing a migration and it makes it easier for data to be manipulated as needed. Mongodb also has a restriction around storing dates only as UTC.

All timezones are stored by their IANA names so it's compatible with browser APIs. There is a newly generated type for SupportedTimezones which is reused across fields.

We handle timezone calculations via a new package @date-fns/tz which we will be using in the future for handling timezone aware scheduled publishing/unpublishing and more.

UI

Dark mode

Light mode

[DanRibbens]

@jacobsfletch did you pull the branch down and test this when you reviewed? If not I plan to do this later today before we merge.

[JarrodMFlesch]

I think we may want to use _tz instead of _timezone as the field suffix here. Shorter names are generally better for PG, and we are adding this one automatically. TZ is also fairly common when talking about dates.

[jacobsfletch]

Few last changes to make here:

• The supportedTimezones array exported from Payload should be renamed defaultTimezones
• This should be typed with a new Timezone[] type
• The supportedTimezones property should accept a function that threads defaultTimezones as an argument
• Need to type supportedTimezones to ensure values are strictly an IANA timezone

[paulpopus]

Added a few more tests to ensure UTC values are set as expected between the summer and winter times (daylight savings). Also tests for the below

Timezone selector is now clearable.

If date field is required and timezone is not provided but enabled it will now throw an error as well.

[github-actions]

🚀 This is included in version v3.23.0