@justanarthur/payload-www 0.1.2 → 0.3.0

package/README.md

@@ -11,7 +11,7 @@ language switcher share a single source of truth with the rest of your app.
 
 - **Composer** — `createWWWConfig({ locales, blocks, defaultPlugins? })` returns `{ withWWWConfig }`. One composer call is enough for the most common cases.
 - **Collections** — `Pages` (title, blocks tab, slug, drafts, revalidation hook), `Posts` (title, excerpt, richText, drafts, revalidation hook), `StaticPages` (system pages — 404, 500, search-empty, … — addressed by a `kind` discriminator, not a slug)
-- **Globals** — `Header` and `Footer` (both `nav` blocks with `navColumn` / `navItem`)
+- **Globals** — `Header` and `Footer` (both `nav` blocks with `navColumn` / `navItem`). Extend the nav link schema (e.g. a `description` or a `navHover` mega-menu group) via `createHeaderGlobal({ navColumnLinkFields, navItemLinkFields })` / `createFooterGlobal({ … })`, or `link({ extraFields })` directly.
 - **Default render components** — `PagesPage`, `HeaderPage`, `FooterPage` Server Components. Override any of them by setting a different `custom.path` on the collection / global.
 - **LivePreviewListener** — built in. The lib's `createCollectionPageExports` default page renders it (via `React.lazy` so the server dist stays free of `'use client'` imports) whenever Next.js draft mode is on. Hosts get live preview automatically — no opt-in required. The component itself is also exported from `/render-components` for hosts that want to mount it elsewhere.
 - **Hooks** — `createRevalidateCollectionHook(opts)` (canonical factory for **all** collections: Pages, Posts, host-defined; per-locale `revalidatePath` fan-out + `revalidateTag('collection_<slug>_<id>', 'max')` + sitemap tag, with a `pathMode: 'tag-only'` mode for collections without a URL like `staticPages`), `createRevalidatePageHooks()` (deprecated alias for Pages preset), `createRevalidateGlobalHook(slug)` (per-locale tag for globals)
@@ -308,6 +308,7 @@ Subpath imports:
 | `blocks`         | `Block[]`                         | yes      | Blocks the Pages collection accepts.                                   |
 | `linkRelationTo` | `string[]`                        | no       | Collection slugs the Header / Footer nav links can reference. Default: `['pages']`. |
 | `registerPosts`  | `boolean`                         | no       | Register the lib's Posts collection. Default `true`. |
+| `nested`         | `boolean`                         | no       | Enable nested Pages slugs (`about_us` → `/about/us`). Relaxes the Pages slug validation to accept the `_` divider. Pass the same `nested: true` to `createCollectionPageExports` on the Pages route (and `nested: { pages: true }` to `createSitemapFile`). Default `false`. |
 | StaticPages      | —                                 | yes      | Always registered (every site has 404). Hosts filter it out in `collections:` to opt. |
 | `defaultPlugins` | `(defaults: Plugin[]) => Plugin[]`| no       | Final say on the default `[seoPlugin, imageHashPlugin, translator]` list. |
 

package/dist/collections.d.ts

@@ -76,6 +76,14 @@ type CreatePagesCollectionOptions = {
 	* when omitted.
 	*/
 	defaultLocale?: CreateRevalidateCollectionHookOptions["defaultLocale"];
+	/**
+	* Enable nested (hierarchical) slugs. When `true`, the slug field
+	* additionally accepts the `_` nesting divider (so `about_us`
+	* renders at `/about/us`) and the admin description documents the
+	* convention. Pair with `createCollectionPageExports({ nested: true })`
+	* on the matching route. Default: `false` (flat, hyphen-only slugs).
+	*/
+	nested?: boolean;
 };
 declare const createPagesCollection: (blocks: Block[], options?: Omit<CreatePagesCollectionOptions, "blocks">) => CollectionConfig;
 import { CollectionConfig as CollectionConfig2 } from "payload";
@@ -134,7 +142,7 @@ type CreateStaticPagesCollectionOptions = {
 	blocks: Block2[];
 };
 declare const createStaticPagesCollection: (blocks: Block2[]) => CollectionConfig3;
-import { GlobalConfig } from "payload";
+import { Field, GlobalConfig } from "payload";
 type CreateHeaderGlobalOptions = {
 	/**
 	* Optional override for the `custom.path` Payload uses to resolve
@@ -148,6 +156,17 @@ type CreateHeaderGlobalOptions = {
 	* different list when your host has additional linkable collections.
 	*/
 	linkRelationTo?: string[];
+	/**
+	* Extra fields appended to each `navColumn` link — e.g. a
+	* `description` text field or a `navHover` group for a mega-menu.
+	* Lets hosts enrich the column-link schema without redefining the
+	* whole nav.
+	*/
+	navColumnLinkFields?: Field[];
+	/**
+	* Extra fields appended to each top-level `navItem` link.
+	*/
+	navItemLinkFields?: Field[];
 };
 /**
 * Build the Header global. The lib's default shape: a `nav` blocks
@@ -155,7 +174,7 @@ type CreateHeaderGlobalOptions = {
 * and `navItem` (a single link).
 */
 declare const createHeaderGlobal: (options?: CreateHeaderGlobalOptions) => GlobalConfig;
-import { GlobalConfig as GlobalConfig2 } from "payload";
+import { Field as Field2, GlobalConfig as GlobalConfig2 } from "payload";
 type CreateFooterGlobalOptions = {
 	/**
 	* Optional override for the `custom.path` Payload uses to resolve
@@ -169,6 +188,16 @@ type CreateFooterGlobalOptions = {
 	* different list when your host has additional linkable collections.
 	*/
 	linkRelationTo?: string[];
+	/**
+	* Extra fields appended to each `navColumn` link — e.g. a
+	* `description` text field. Lets hosts enrich the column-link
+	* schema without redefining the whole nav.
+	*/
+	navColumnLinkFields?: Field2[];
+	/**
+	* Extra fields appended to each top-level `navItem` link.
+	*/
+	navItemLinkFields?: Field2[];
 };
 /**
 * Build the Footer global. The lib's default shape mirrors the

package/dist/collections.js

@@ -23,7 +23,6 @@ var authenticatedOrPublished = ({ req: { user } }) => {
     return true;
   return { _status: { equals: "published" } };
 };
-
 // src/render/_locale.ts
 function prefixFor(locale, defaultLocale, mode) {
   if (mode === "never")
@@ -195,24 +194,9 @@ var createPagesCollection = (blocks, options = {}) => {
     renderPath = PAGES_RENDER_PATH,
     slug: collectionSlug = PAGES_SLUG2,
     localePrefix,
-    defaultLocale
+    defaultLocale,
+    nested = false
   } = options;
-  const slugField = {
-    name: "slug",
-    type: "text",
-    required: true,
-    unique: true,
-    index: true,
-    admin: { position: "sidebar" },
-    validate: (value) => {
-      if (typeof value !== "string")
-        return "Slug must be a string";
-      if (value !== "" && !/^[a-z0-9-]+$/.test(value)) {
-        return "Slug must be lowercase, with hyphens (no spaces or special characters)";
-      }
-      return true;
-    }
-  };
   const baseFields = [
     {
       name: "title",
@@ -242,7 +226,7 @@ var createPagesCollection = (blocks, options = {}) => {
       type: "date",
       admin: { position: "sidebar" }
     },
-    slugField
+    slugField({ nested })
   ];
   const { afterChange: revalidateAfterChange, afterDelete: revalidateAfterDelete } = createRevalidateCollectionHook({
     collectionSlug,
@@ -277,14 +261,6 @@ var createPostsCollection = (options = {}) => {
     localePrefix,
     defaultLocale
   } = options;
-  const slugField = {
-    name: "slug",
-    type: "text",
-    required: true,
-    unique: true,
-    index: true,
-    admin: { position: "sidebar" }
-  };
   const baseFields = [
     {
       name: "title",
@@ -309,7 +285,7 @@ var createPostsCollection = (options = {}) => {
       type: "date",
       admin: { position: "sidebar" }
     },
-    slugField
+    slugField()
   ];
   const { afterChange, afterDelete } = createRevalidateCollectionHook({
     collectionSlug,
@@ -410,17 +386,18 @@ var createStaticPagesCollection = (blocks) => {
 };
 
 // src/core/fields/link.ts
-var appearanceOptions = {
+var appearanceOptions2 = {
   default: { label: "Default", value: "default" },
   outline: { label: "Outline", value: "outline" }
 };
-var link = (options = {}) => {
+var link2 = (options = {}) => {
   const {
     appearances,
     disableLabel = false,
     relationTo = [PAGES_SLUG],
     localized = false,
-    overrides = {}
+    overrides = {},
+    extraFields = []
   } = options;
   const result = {
     name: "link",
@@ -488,7 +465,7 @@ var link = (options = {}) => {
     result.fields = [...result.fields, ...linkTypes];
   }
   if (appearances !== false) {
-    const opts = appearances ? appearances.map((a) => appearanceOptions[a]) : [appearanceOptions.default, appearanceOptions.outline];
+    const opts = appearances ? appearances.map((a) => appearanceOptions2[a]) : [appearanceOptions2.default, appearanceOptions2.outline];
     result.fields.push({
       name: "appearance",
       type: "select",
@@ -497,6 +474,9 @@ var link = (options = {}) => {
       options: opts
     });
   }
+  if (extraFields.length) {
+    result.fields.push(...extraFields);
+  }
   return { ...result, ...overrides };
 };
 
@@ -516,17 +496,22 @@ function createRevalidateGlobalHook(slug) {
 
 // src/data/collections/globals/Header/config.ts
 var createHeaderGlobal = (options = {}) => {
-  const { renderPath = HEADER_RENDER_PATH, linkRelationTo = [PAGES_SLUG] } = options;
+  const {
+    renderPath = HEADER_RENDER_PATH,
+    linkRelationTo = [PAGES_SLUG],
+    navColumnLinkFields = [],
+    navItemLinkFields = []
+  } = options;
   const navColumnBlock = {
     slug: "navColumn",
     fields: [
       { name: "title", type: "text", required: true, localized: true },
-      { name: "links", type: "array", fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })] }
+      { name: "links", type: "array", fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navColumnLinkFields })] }
     ]
   };
   const navItemBlock = {
     slug: "navItem",
-    fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })]
+    fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navItemLinkFields })]
   };
   return {
     slug: "header",
@@ -548,17 +533,22 @@ var createHeaderGlobal = (options = {}) => {
 
 // src/data/collections/globals/Footer/config.ts
 var createFooterGlobal = (options = {}) => {
-  const { renderPath = FOOTER_RENDER_PATH, linkRelationTo = [PAGES_SLUG] } = options;
+  const {
+    renderPath = FOOTER_RENDER_PATH,
+    linkRelationTo = [PAGES_SLUG],
+    navColumnLinkFields = [],
+    navItemLinkFields = []
+  } = options;
   const navColumnBlock = {
     slug: "navColumn",
     fields: [
       { name: "title", type: "text", required: true, localized: true },
-      { name: "links", type: "array", fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })] }
+      { name: "links", type: "array", fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navColumnLinkFields })] }
     ]
   };
   const navItemBlock = {
     slug: "navItem",
-    fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })]
+    fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navItemLinkFields })]
   };
   return {
     slug: "footer",

package/dist/config.d.ts

@@ -58,6 +58,14 @@ type WWWConfigOptions = {
 	*/
 	registerPosts?: boolean;
 	/**
+	* Enable nested (hierarchical) Pages slugs. When `true`, the lib's
+	* Pages collection accepts the `_` nesting divider in its slug
+	* (`about_us` → `/about/us`). Pass the same `nested: true` to
+	* `createCollectionPageExports` on the Pages route so URL building,
+	* hreflang, and static params expand the divider. Default: `false`.
+	*/
+	nested?: boolean;
+	/**
 	* Final say on the lib's default plugin list. Receives the
 	* `[seoPlugin, imageHashPlugin, translator]` array; return the
 	* list to apply. Common uses: drop the translator (no AI

package/dist/config.js

@@ -23,7 +23,6 @@ var authenticatedOrPublished = ({ req: { user } }) => {
     return true;
   return { _status: { equals: "published" } };
 };
-
 // src/render/_locale.ts
 function prefixFor(locale, defaultLocale, mode) {
   if (mode === "never")
@@ -195,24 +194,9 @@ var createPagesCollection = (blocks, options = {}) => {
     renderPath = PAGES_RENDER_PATH,
     slug: collectionSlug = PAGES_SLUG2,
     localePrefix,
-    defaultLocale
+    defaultLocale,
+    nested = false
   } = options;
-  const slugField = {
-    name: "slug",
-    type: "text",
-    required: true,
-    unique: true,
-    index: true,
-    admin: { position: "sidebar" },
-    validate: (value) => {
-      if (typeof value !== "string")
-        return "Slug must be a string";
-      if (value !== "" && !/^[a-z0-9-]+$/.test(value)) {
-        return "Slug must be lowercase, with hyphens (no spaces or special characters)";
-      }
-      return true;
-    }
-  };
   const baseFields = [
     {
       name: "title",
@@ -242,7 +226,7 @@ var createPagesCollection = (blocks, options = {}) => {
       type: "date",
       admin: { position: "sidebar" }
     },
-    slugField
+    slugField({ nested })
   ];
   const { afterChange: revalidateAfterChange, afterDelete: revalidateAfterDelete } = createRevalidateCollectionHook({
     collectionSlug,
@@ -277,14 +261,6 @@ var createPostsCollection = (options = {}) => {
     localePrefix,
     defaultLocale
   } = options;
-  const slugField = {
-    name: "slug",
-    type: "text",
-    required: true,
-    unique: true,
-    index: true,
-    admin: { position: "sidebar" }
-  };
   const baseFields = [
     {
       name: "title",
@@ -309,7 +285,7 @@ var createPostsCollection = (options = {}) => {
       type: "date",
       admin: { position: "sidebar" }
     },
-    slugField
+    slugField()
   ];
   const { afterChange, afterDelete } = createRevalidateCollectionHook({
     collectionSlug,
@@ -410,17 +386,18 @@ var createStaticPagesCollection = (blocks) => {
 };
 
 // src/core/fields/link.ts
-var appearanceOptions = {
+var appearanceOptions2 = {
   default: { label: "Default", value: "default" },
   outline: { label: "Outline", value: "outline" }
 };
-var link = (options = {}) => {
+var link2 = (options = {}) => {
   const {
     appearances,
     disableLabel = false,
     relationTo = [PAGES_SLUG],
     localized = false,
-    overrides = {}
+    overrides = {},
+    extraFields = []
   } = options;
   const result = {
     name: "link",
@@ -488,7 +465,7 @@ var link = (options = {}) => {
     result.fields = [...result.fields, ...linkTypes];
   }
   if (appearances !== false) {
-    const opts = appearances ? appearances.map((a) => appearanceOptions[a]) : [appearanceOptions.default, appearanceOptions.outline];
+    const opts = appearances ? appearances.map((a) => appearanceOptions2[a]) : [appearanceOptions2.default, appearanceOptions2.outline];
     result.fields.push({
       name: "appearance",
       type: "select",
@@ -497,6 +474,9 @@ var link = (options = {}) => {
       options: opts
     });
   }
+  if (extraFields.length) {
+    result.fields.push(...extraFields);
+  }
   return { ...result, ...overrides };
 };
 
@@ -516,17 +496,22 @@ function createRevalidateGlobalHook(slug) {
 
 // src/data/collections/globals/Header/config.ts
 var createHeaderGlobal = (options = {}) => {
-  const { renderPath = HEADER_RENDER_PATH, linkRelationTo = [PAGES_SLUG] } = options;
+  const {
+    renderPath = HEADER_RENDER_PATH,
+    linkRelationTo = [PAGES_SLUG],
+    navColumnLinkFields = [],
+    navItemLinkFields = []
+  } = options;
   const navColumnBlock = {
     slug: "navColumn",
     fields: [
       { name: "title", type: "text", required: true, localized: true },
-      { name: "links", type: "array", fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })] }
+      { name: "links", type: "array", fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navColumnLinkFields })] }
     ]
   };
   const navItemBlock = {
     slug: "navItem",
-    fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })]
+    fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navItemLinkFields })]
   };
   return {
     slug: "header",
@@ -548,17 +533,22 @@ var createHeaderGlobal = (options = {}) => {
 
 // src/data/collections/globals/Footer/config.ts
 var createFooterGlobal = (options = {}) => {
-  const { renderPath = FOOTER_RENDER_PATH, linkRelationTo = [PAGES_SLUG] } = options;
+  const {
+    renderPath = FOOTER_RENDER_PATH,
+    linkRelationTo = [PAGES_SLUG],
+    navColumnLinkFields = [],
+    navItemLinkFields = []
+  } = options;
   const navColumnBlock = {
     slug: "navColumn",
     fields: [
       { name: "title", type: "text", required: true, localized: true },
-      { name: "links", type: "array", fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })] }
+      { name: "links", type: "array", fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navColumnLinkFields })] }
     ]
   };
   const navItemBlock = {
     slug: "navItem",
-    fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })]
+    fields: [link2({ appearances: false, localized: true, relationTo: linkRelationTo, extraFields: navItemLinkFields })]
   };
   return {
     slug: "footer",
@@ -647,7 +637,7 @@ function getFromImportMap(key, importMap) {
 var queryDocBySlug = cache(async function queryDocBySlug2({
   collectionSlug,
   slug,
-  slugField = "slug",
+  slugField: slugField2 = "slug",
   locale,
   draft = false,
   config
@@ -659,14 +649,14 @@ var queryDocBySlug = cache(async function queryDocBySlug2({
     limit: 1,
     pagination: false,
     overrideAccess: draft,
-    where: { [slugField]: { equals: slug } },
+    where: { [slugField2]: { equals: slug } },
     locale
   });
   return result.docs?.[0] ?? null;
 });
 var queryAllDocs = cache(async function queryAllDocs2({
   collectionSlug,
-  slugField = "slug",
+  slugField: slugField2 = "slug",
   locale,
   config
 }) {
@@ -677,7 +667,7 @@ var queryAllDocs = cache(async function queryAllDocs2({
     limit: 1000,
     pagination: false,
     overrideAccess: false,
-    select: { [slugField]: true },
+    select: { [slugField2]: true },
     locale
   });
   return result.docs ?? [];
@@ -685,7 +675,7 @@ var queryAllDocs = cache(async function queryAllDocs2({
 var queryAllLocaleSlugs = cache(async function queryAllLocaleSlugs2({
   collectionSlug,
   slug,
-  slugField = "slug",
+  slugField: slugField2 = "slug",
   locale,
   config
 }) {
@@ -697,13 +687,25 @@ var queryAllLocaleSlugs = cache(async function queryAllLocaleSlugs2({
     pagination: false,
     overrideAccess: false,
     locale,
-    where: { [slugField]: { equals: slug } },
-    select: { [slugField]: true }
+    where: { [slugField2]: { equals: slug } },
+    select: { [slugField2]: true }
   });
   const doc = result.docs?.[0];
   if (!doc)
     return;
-  const fieldValue = doc?.[slugField];
+  let fieldValue = doc[slugField2];
+  if (doc.id != null) {
+    const allLocales2 = await payload.findByID({
+      collection: collectionSlug,
+      id: doc.id,
+      locale: "all",
+      draft: false,
+      overrideAccess: false,
+      select: { [slugField2]: true }
+    }).catch(() => null);
+    if (allLocales2)
+      fieldValue = allLocales2[slugField2];
+  }
   if (fieldValue && typeof fieldValue === "object") {
     return fieldValue;
   }
@@ -756,6 +758,7 @@ function createSitemapFile(options) {
       const collectionDefaults = options.perCollection?.[collectionSlug] ?? {};
       const urlPrefix = (options.urlPrefixes?.[collectionSlug] ?? "").replace(/\/$/, "");
       const siteUrl = options.getServerSideURL().replace(/\/$/, "");
+      const isNested = options.nested?.[collectionSlug] ?? false;
       for (const locale of activeLocales) {
         const docs = await queryAllDocs({
           collectionSlug,
@@ -771,13 +774,14 @@ function createSitemapFile(options) {
           if (seen.has(dedupeKey))
             continue;
           seen.add(dedupeKey);
-          const url = `${siteUrl}${prefixFor(locale, defaultLocale, options.localePrefix ?? "always")}${urlPrefix}/${storedSlug}`;
+          const slugPath = isNested ? storedSlug.replaceAll("_", "/") : storedSlug;
+          const url = `${siteUrl}${prefixFor(locale, defaultLocale, options.localePrefix ?? "always")}${urlPrefix}/${slugPath}`;
           const languages = await buildHreflangAlternates({
             siteUrl,
             locale,
             urlPrefix,
             storedSlug,
-            nested: false,
+            nested: isNested,
             homeSlug: "",
             defaultLocale,
             locales: activeLocales,
@@ -808,7 +812,7 @@ function createSitemapFile(options) {
 }
 // src/config/createWWWConfig.ts
 function createWWWConfig(options) {
-  const { locales, routing, blocks, linkRelationTo, registerPosts = true, defaultPlugins } = options;
+  const { locales, routing, blocks, linkRelationTo, registerPosts = true, nested = false, defaultPlugins } = options;
   const defaultLocale = routing?.defaultLocale ?? locales[0] ?? "";
   const localePrefixMode = (() => {
     const raw = routing?.localePrefix;
@@ -821,7 +825,8 @@ function createWWWConfig(options) {
   }
   const buildPagesCollection = () => createPagesCollection(blocks, {
     localePrefix: localePrefixMode,
-    defaultLocale
+    defaultLocale,
+    nested
   });
   const buildPostsCollection = () => createPostsCollection({
     localePrefix: localePrefixMode,

package/dist/core-fields.d.ts

@@ -20,10 +20,46 @@ type LinkOptions = {
 	overrides?: Partial<GroupField>;
 	/** Legacy alias for the host's custom field overrides. */
 	linkOverrides?: Partial<GroupField>;
+	/**
+	* Extra fields appended to the link group — e.g. a `description`
+	* text field or a `navHover` group for a mega-menu. Lets hosts
+	* extend the nav link schema without re-implementing the whole
+	* `link` field. Appended after the standard type/label/appearance
+	* fields.
+	*/
+	extraFields?: Field[];
 };
 declare const link: (options?: LinkOptions) => Field;
 import { Field as Field2 } from "payload";
 declare const linkGroup: (options?: LinkOptions) => Field2;
+import { Field as Field3 } from "payload";
+type SlugFieldOptions = {
+	/** Field name. Default: `'slug'`. */
+	name?: string;
+	/**
+	* Allow the `_` nesting divider in the slug so `about_us` renders at
+	* `/about/us`. Relaxes validation and documents the convention in the
+	* admin UI. Pair with `createCollectionPageExports({ nested: true })`.
+	* Default: `false`.
+	*/
+	nested?: boolean;
+	/**
+	* Localize the slug — one slug per locale (`/about` in `en`, `/o-nas`
+	* in `sk`), stored in the collection's `_locales` table. This is the
+	* default: the lib's collections are multilingual, so per-locale slugs
+	* power localized URLs and hreflang alternates. Pass `false` for a
+	* single shared slug.
+	*/
+	localized?: boolean;
+};
+/**
+* The slug field shared by the lib's Pages / Posts collections: a
+* required, unique, indexed, sidebar text field, localized by default.
+*
+* The empty string is reserved for the home page (rendered at
+* `/${locale}`), so validation only rejects non-empty malformed values.
+*/
+declare const slugField: (options?: SlugFieldOptions) => Field3;
 import { Field as Field_14espm } from "payload";
 declare const _default: {
 	link: (options?: LinkOptions) => Field_14espm;
@@ -32,5 +68,6 @@ declare const _default: {
 		label: string;
 		value: string;
 	}>;
+	slugField: (options?: SlugFieldOptions) => Field_14espm;
 };
-export { linkGroup, link, _default as default, appearanceOptions, LinkOptions, LinkAppearances };
+export { slugField, linkGroup, link, _default as default, appearanceOptions, SlugFieldOptions, LinkOptions, LinkAppearances };

package/dist/core-fields.js

@@ -36,7 +36,8 @@ var link = (options = {}) => {
     disableLabel = false,
     relationTo = [PAGES_SLUG],
     localized = false,
-    overrides = {}
+    overrides = {},
+    extraFields = []
   } = options;
   const result = {
     name: "link",
@@ -113,6 +114,9 @@ var link = (options = {}) => {
       options: opts
     });
   }
+  if (extraFields.length) {
+    result.fields.push(...extraFields);
+  }
   return { ...result, ...overrides };
 };
 
@@ -124,9 +128,38 @@ var linkGroup = (options = {}) => ({
   admin: { initCollapsed: true }
 });
 
+// src/core/fields/slug.ts
+var FLAT_PATTERN = /^[a-z0-9-]+$/;
+var NESTED_PATTERN = /^[a-z0-9_-]+$/;
+var slugField = (options = {}) => {
+  const { name = "slug", nested = false, localized = true } = options;
+  const pattern = nested ? NESTED_PATTERN : FLAT_PATTERN;
+  const invalidMessage = nested ? "Slug must be lowercase, with hyphens or the `_` nesting divider (no spaces or other special characters)" : "Slug must be lowercase, with hyphens (no spaces or special characters)";
+  return {
+    name,
+    type: "text",
+    required: true,
+    unique: true,
+    index: true,
+    localized,
+    admin: {
+      position: "sidebar",
+      ...nested ? { description: "Lowercase, hyphens for words. Use the `_` divider for nesting, e.g. `about_us` → `/about/us`." } : {}
+    },
+    validate: (value) => {
+      if (typeof value !== "string")
+        return "Slug must be a string";
+      if (value !== "" && !pattern.test(value))
+        return invalidMessage;
+      return true;
+    }
+  };
+};
+
 // src/exports/core-fields.ts
-var core_fields_default = { link, linkGroup, appearanceOptions };
+var core_fields_default = { link, linkGroup, appearanceOptions, slugField };
 export {
+  slugField,
   linkGroup,
   link,
   core_fields_default as default,