Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/move-fields-directory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
'@ainsleydev/payload-helper': patch
---

Add PublishedAt and URLField field helpers, expose via ./fields export path, and fix URLField crash when generate returns undefined
Add PublishedAt and URLField field helpers and expose via ./fields export path
4 changes: 4 additions & 0 deletions packages/payload-helper/src/common/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
export { SEOFields } from './SEO.js';
export { PublishedAt } from '../fields/PublishedAt.js';
export type { PublishedAtArgs } from '../fields/PublishedAt.js';
export { URLField } from '../fields/URLField.js';
export type { URLFieldArgs } from '../fields/URLField.js';
5 changes: 4 additions & 1 deletion packages/payload-helper/src/fields/PublishedAt.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ describe('PublishedAt', () => {
});
});

test('top-level overrides replace admin when admin is overridden', () => {
test('deep merges admin overrides with defaults', () => {
const field = PublishedAt({
overrides: {
admin: {
Expand All @@ -110,6 +110,9 @@ describe('PublishedAt', () => {
expect((field as DateField).admin).toMatchObject({
position: 'sidebar',
description: 'Custom description',
date: {
pickerAppearance: 'dayOnly',
},
});
});

Expand Down
6 changes: 3 additions & 3 deletions packages/payload-helper/src/fields/PublishedAt.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { DateField, Field } from 'payload';
import { deepMerge } from 'payload';

export type PublishedAtArgs = {
overrides?: Partial<DateField>;
Expand All @@ -13,7 +14,7 @@ export type PublishedAtArgs = {
* @param args - Optional arguments to customise the field.
*/
export const PublishedAt = (args?: PublishedAtArgs): Field => {
return {
const baseField: Field = {
name: 'publishedAt',
type: 'date',
required: true,
Expand All @@ -23,7 +24,6 @@ export const PublishedAt = (args?: PublishedAtArgs): Field => {
date: {
pickerAppearance: 'dayOnly',
},
...args?.overrides?.admin,
},
hooks: {
beforeChange: [
Expand All @@ -35,6 +35,6 @@ export const PublishedAt = (args?: PublishedAtArgs): Field => {
},
],
},
...args?.overrides,
};
return deepMerge<Field, Partial<DateField>>(baseField, args?.overrides || {});
};
10 changes: 10 additions & 0 deletions packages/payload-helper/src/fields/URLField.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ describe('URLField', () => {
expect(result).toBe('https://example.com/page?draft=true');
});

test('appends draft parameter correctly when URL already has query params', async () => {
const field = URLField({
generate: () => 'https://example.com/page?foo=bar',
});

const hooks = (field as TextField).hooks?.afterRead;
const result = await hooks?.[0]({ draft: true } as unknown as FieldHookArgs<TypeWithID>);
expect(result).toBe('https://example.com/page?foo=bar&draft=true');
});

test('handles async generate function', async () => {
const field = URLField({
generate: async () => 'https://example.com/async',
Expand Down
4 changes: 3 additions & 1 deletion packages/payload-helper/src/fields/URLField.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ export const URLField = <T extends TypeWithID>({ generate, overrides }: URLField
return url;
}
if (args.draft) {
return `${url}?draft=true`;
const u = new URL(url);
u.searchParams.set('draft', 'true');
return u.toString();
}
return url;
},
Expand Down