@bison-lab/payload-core 3.24.0 → 3.25.0

package/README.md

@@ -8,10 +8,10 @@ are extracted.
 Full guide: <https://payload.bisonlab.ai/site/seo/>
 
 ```bash
-pnpm add @bison-lab/payload-core @payloadcms/plugin-seo @bison-lab/tokens @bison-lab/fonts
+pnpm add @bison-lab/payload-core @payloadcms/plugin-seo @payloadcms/plugin-redirects @bison-lab/tokens @bison-lab/fonts
 ```
 
-Peers: `payload` and `@payloadcms/plugin-seo` are required. `@bison-lab/tokens`
+Peers: `payload`, `@payloadcms/plugin-seo`, and `@payloadcms/plugin-redirects` are required. `@bison-lab/tokens`
 and `@bison-lab/fonts` are needed to adopt the Theme Global; `@payloadcms/ui`
 and `react` are needed for its admin fields; `@bison-lab/ui` and
 `@payloadcms/live-preview-react` are needed for the live theme preview.
@@ -22,7 +22,7 @@ lockstep.
 
 | Import                             | Contents                                                                                         | Runs where                                                                 |
 | ---------------------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
-| `@bison-lab/payload-core`          | `seoPlugin`, `createTheme`, `createBrandAssets`, `createRoles`, `createFeatures`, `createPages`, `createUsers`, `createMedia`, `createAdminNav`, `adminNav`, `createNavigation`, `adminOnlyApiTab`, `documentTitleActions`, `seedTheme`, `seedRoles`, `seedFeatures`, predicates, `lookField`, `colorTokenField`, import-map strings, title and text helpers, types | Node. What `payload.config.ts` imports; it loads the plugin. |
+| `@bison-lab/payload-core`          | `seoPlugin`, `createTheme`, `createBrandAssets`, `createRoles`, `createFeatures`, `createPages`, `createUsers`, `createMedia`, `createRedirects`, `createAdminNav`, `adminNav`, `createNavigation`, `adminOnlyApiTab`, `documentTitleActions`, `seedTheme`, `seedRoles`, `seedFeatures`, predicates, `lookField`, `colorTokenField`, import-map strings, title and text helpers, types | Node. What `payload.config.ts` imports; it loads the plugin. |
 | `@bison-lab/payload-core/metadata` | `pageMetadata`, the title helpers, the same types                                                | Server. What a page route imports; it does not load the plugin.            |
 | `@bison-lab/payload-core/theme`    | `getPublishedTheme`, `getPublishedIdentity`, `themeConfigFromDoc`, `themeHead`, `themeHeadFromDoc` | Server. What a root layout imports; it does not load the plugin or React.  |
 | `@bison-lab/payload-core/navigation` | `getNavigation`, the Header and Footer slugs                                                  | Server. What a site header imports; it does not load the plugin or React.  |
@@ -45,11 +45,12 @@ the site spells its name and its URL scheme once.
 
 ```ts
 // payload.config.ts
-import { firstImageIn, seoPlugin } from "@bison-lab/payload-core";
+import { createRedirects, firstImageIn, seoPlugin } from "@bison-lab/payload-core";
 import type { Page } from "@/payload-types";
 
 export default buildConfig({
   plugins: [
+    createRedirects(),
     seoPlugin<Page>({
       siteName: "Acme Clinics",
       urlFor: (doc) => (doc.slug ? absoluteUrl(pagePath(doc.slug)) : undefined),
@@ -318,10 +319,16 @@ read from the live Features and Roles Globals) so Payload's
 ## Pages, users, and media
 
 `createPages`, `createUsers`, `createMedia`, `slugField`,
-`adminOnlyApiTab`, and `documentTitleActions` ship from the same
+`createRedirects`, `adminOnlyApiTab`, and `documentTitleActions` ship from the same
 React-free entry. Pages take the
 site's hero and layout blocks, reserved-slug predicate, and preview
-path. Create follows the Content tick. Update without Publish is
+path. The slug follows the title until first publish, then locks. Unlock
+warns in plain words and the same save writes a 308. `createRedirects()`
+wraps `@payloadcms/plugin-redirects` for `pages` only (permanent 308) and
+collapses chains when a published slug changes. The plugin stores the
+rows; the site still has to serve them. Pin the plugin to the same
+version as `payload`, then `payload generate:importmap`,
+`payload generate:types`, and `payload migrate:create`. Create follows the Content tick. Update without Publish is
 constrained to `_status: draft` — an Author can save a draft and cannot
 publish or edit a live page. Users sit under Settings next to Roles,
 take `secureCookies`, and offer whatever rows the Global (or the seed
@@ -418,6 +425,7 @@ to a type that has one.
 
 `noIndexField`, the plugin's own fields, the Theme Global fields, the
 Roles Global fields, the Admin nav fields, the Header and Footer fields,
-and the brand-assets collection fields are columns
+the Pages slug lock fields, the Redirects collection, and the
+brand-assets collection fields are columns
 in every consuming site. A change to them is a schema change: say "run
 `payload migrate:create`" in the changeset.

package/dist/admin.d.mts

@@ -126,6 +126,13 @@ declare function RolesRowLabel(): react_jsx_runtime0.JSX.Element;
  */
 declare const RoleSlugField: TextFieldClientComponent;
 //#endregion
+//#region src/admin/slug-field.d.ts
+/**
+ * Slug follows the title until first publish. After that it is read-only
+ * until Unlock, which warns that the old address will redirect.
+ */
+declare const SlugField: TextFieldClientComponent;
+//#endregion
 //#region src/admin/role-name-field.d.ts
 /**
  * Role name. Letters and spaces only, so the hidden slug stays
@@ -214,5 +221,5 @@ declare function AdminNavItemRowLabel(): react_jsx_runtime0.JSX.Element;
  */
 declare const AdminNavEntityField: TextFieldClientComponent;
 //#endregion
-export { AdminNav, AdminNavEntityField, AdminNavItemRowLabel, AdminNavRowLabel, AppearanceField, ColorField, ColorScaleField, ContrastReport, DocumentCreateNew, DocumentTitleActions, FeaturesMatrixField, FontField, GreyScaleField, HiddenSaveButton, IdentityFallback, LibraryField, LookField, PairingField, PublishChild, RoleNameField, RoleSlugField, RolesField, RolesGrantsField, RolesMatrixField, RolesRowLabel, SectionHeading, ThemeDocumentControls, ThemeSaveButton, setThemePreviewMode };
+export { AdminNav, AdminNavEntityField, AdminNavItemRowLabel, AdminNavRowLabel, AppearanceField, ColorField, ColorScaleField, ContrastReport, DocumentCreateNew, DocumentTitleActions, FeaturesMatrixField, FontField, GreyScaleField, HiddenSaveButton, IdentityFallback, LibraryField, LookField, PairingField, PublishChild, RoleNameField, RoleSlugField, RolesField, RolesGrantsField, RolesMatrixField, RolesRowLabel, SectionHeading, SlugField, ThemeDocumentControls, ThemeSaveButton, setThemePreviewMode };
 //# sourceMappingURL=admin.d.mts.map

package/dist/admin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"admin.d.mts","names":[],"sources":["../src/admin/color-field.tsx","../src/admin/color-scale-field.tsx","../src/admin/library-field.tsx","../src/admin/font-field.tsx","../src/admin/pairing-field.tsx","../src/admin/appearance-field.tsx","../src/admin/grey-scale-field.tsx","../src/admin/contrast-report.tsx","../src/admin/section-heading.tsx","../src/admin/publish-child.tsx","../src/admin/save-button.tsx","../src/admin/preview-mode.tsx","../src/admin/identity-fallback.tsx","../src/admin/look-field.tsx","../src/admin/roles-matrix-field.tsx","../src/admin/roles-row-label.tsx","../src/admin/role-slug-field.tsx","../src/admin/role-name-field.tsx","../src/admin/roles-field.tsx","../src/admin/roles-grants-field.tsx","../src/admin/features-matrix-field.tsx","../src/admin/document-title-actions.tsx","../src/admin/document-create-new.tsx","../src/admin-nav/types.ts","../src/admin/admin-nav.tsx","../src/admin/admin-nav-row-label.tsx","../src/admin/admin-nav-item-row-label.tsx","../src/admin/admin-nav-entity-field.tsx"],"mappings":";;;;;;;;;;;cAWa,UAAA,EAAY,wBAAA;;;;;;;cCsBZ,eAAA,EAAiB,yBAAA;;;;;;;;;cCOjB,YAAA,EAAc,yBAAA;;;;;;;;;cCtBd,SAAA,EAAW,0BAAA;;;;;;;cCNX,YAAA,EAAc,sBAAA;;;;;;;cCCd,eAAA,EAAiB,yBAAA;;;ALF9B;;;;AAAA,cM4Da,cAAA,EAAgB,0BAAA;;;;;;;cCnDhB,cAAA,EAAgB,sBAAA;;;;;;cCbhB,cAAA,EAAgB,sBAAA;;;cC0IhB,YAAA,EAAc,sBAAA;;;;;;;;iBCtIX,qBAAA,CAAA;;AVAhB;;;iBUQgB,eAAA,CAAA,GAAe,kBAAA,CAAA,GAAA,CAAA,OAAA;;iBA0Bf,gBAAA,CAAA,GAAgB,kBAAA,CAAA,GAAA,CAAA,OAAA;;;KCrCpB,gBAAA;AAAA,iBAkCI,mBAAA,CAAoB,IAAA,EAAM,gBAAA;;;;;;;cClC7B,gBAAA,EAAkB,sBAAA;;;;;;;cCIlB,SAAA,EAAW,wBAAA;;;;;;;;cCqBX,gBAAA,EAAkB,yBAAA;;;;;;iBC1Bf,aAAA,CAAA,GAAa,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;cCChB,aAAA,EAAe,wBAAA;;;;;;;cCCf,aAAA,EAAe,wBAAA;;;;;;;;cC8Cf,UAAA,EAAY,0BAAA;;;;;;;;cChCZ,gBAAA,EAAkB,wBAAA;;;;;;;;;AnBZ/B;;coB0Ca,mBAAA,EAAqB,yBAAA;;;iBCflB,oBAAA,CAAA;EAAuB;AAAA;EAAc,QAAA,GAAW,SAAA;AAAA,IAAW,kBAAA,CAAA,GAAA,CAAA,OAAA;;;iBCxB3D,iBAAA,CAAA;EAAoB;AAAA;EAAU,IAAA;AAAA,IAAc,kBAAA,CAAA,GAAA,CAAA,OAAA;;;UCmB3C,uBAAA;EACf,WAAA;EACA,OAAA;AAAA;;;UC5Be,aAAA;EACf,eAAA,GAAkB,uBAAA;AAAA;;;AxBGpB;;;iBwB6CgB,QAAA,CAAA;EAAW;AAAA,GAAmB,aAAA,GAAa,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;iBCnD3C,gBAAA,CAAA,GAAgB,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;;iBCGhB,oBAAA,CAAA,GAAoB,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;;;cCEvB,mBAAA,EAAqB,wBAAA"}
+{"version":3,"file":"admin.d.mts","names":[],"sources":["../src/admin/color-field.tsx","../src/admin/color-scale-field.tsx","../src/admin/library-field.tsx","../src/admin/font-field.tsx","../src/admin/pairing-field.tsx","../src/admin/appearance-field.tsx","../src/admin/grey-scale-field.tsx","../src/admin/contrast-report.tsx","../src/admin/section-heading.tsx","../src/admin/publish-child.tsx","../src/admin/save-button.tsx","../src/admin/preview-mode.tsx","../src/admin/identity-fallback.tsx","../src/admin/look-field.tsx","../src/admin/roles-matrix-field.tsx","../src/admin/roles-row-label.tsx","../src/admin/role-slug-field.tsx","../src/admin/slug-field.tsx","../src/admin/role-name-field.tsx","../src/admin/roles-field.tsx","../src/admin/roles-grants-field.tsx","../src/admin/features-matrix-field.tsx","../src/admin/document-title-actions.tsx","../src/admin/document-create-new.tsx","../src/admin-nav/types.ts","../src/admin/admin-nav.tsx","../src/admin/admin-nav-row-label.tsx","../src/admin/admin-nav-item-row-label.tsx","../src/admin/admin-nav-entity-field.tsx"],"mappings":";;;;;;;;;;;cAWa,UAAA,EAAY,wBAAA;;;;;;;cCsBZ,eAAA,EAAiB,yBAAA;;;;;;;;;cCOjB,YAAA,EAAc,yBAAA;;;;;;;;;cCtBd,SAAA,EAAW,0BAAA;;;;;;;cCNX,YAAA,EAAc,sBAAA;;;;;;;cCCd,eAAA,EAAiB,yBAAA;;;ALF9B;;;;AAAA,cM4Da,cAAA,EAAgB,0BAAA;;;;;;;cCnDhB,cAAA,EAAgB,sBAAA;;;;;;cCbhB,cAAA,EAAgB,sBAAA;;;cC0IhB,YAAA,EAAc,sBAAA;;;;;;;;iBCtIX,qBAAA,CAAA;;AVAhB;;;iBUQgB,eAAA,CAAA,GAAe,kBAAA,CAAA,GAAA,CAAA,OAAA;;iBA0Bf,gBAAA,CAAA,GAAgB,kBAAA,CAAA,GAAA,CAAA,OAAA;;;KCrCpB,gBAAA;AAAA,iBAkCI,mBAAA,CAAoB,IAAA,EAAM,gBAAA;;;;;;;cClC7B,gBAAA,EAAkB,sBAAA;;;;;;;cCIlB,SAAA,EAAW,wBAAA;;;;;;;;cCqBX,gBAAA,EAAkB,yBAAA;;;;;;iBC1Bf,aAAA,CAAA,GAAa,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;cCChB,aAAA,EAAe,wBAAA;;;;;;;cCGf,SAAA,EAAW,wBAAA;;;;;;;cCFX,aAAA,EAAe,wBAAA;;;;;;;;cC8Cf,UAAA,EAAY,0BAAA;;;;;;;;cChCZ,gBAAA,EAAkB,wBAAA;;;;;;;;;ApBZ/B;;cqB0Ca,mBAAA,EAAqB,yBAAA;;;iBCflB,oBAAA,CAAA;EAAuB;AAAA;EAAc,QAAA,GAAW,SAAA;AAAA,IAAW,kBAAA,CAAA,GAAA,CAAA,OAAA;;;iBCxB3D,iBAAA,CAAA;EAAoB;AAAA;EAAU,IAAA;AAAA,IAAc,kBAAA,CAAA,GAAA,CAAA,OAAA;;;UCmB3C,uBAAA;EACf,WAAA;EACA,OAAA;AAAA;;;UC5Be,aAAA;EACf,eAAA,GAAkB,uBAAA;AAAA;;;AzBGpB;;;iByB6CgB,QAAA,CAAA;EAAW;AAAA,GAAmB,aAAA,GAAa,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;iBCnD3C,gBAAA,CAAA,GAAgB,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;;iBCGhB,oBAAA,CAAA,GAAoB,kBAAA,CAAA,GAAA,CAAA,OAAA;;;;;;;;cCEvB,mBAAA,EAAqB,wBAAA"}

package/dist/admin.mjs

@@ -4,10 +4,11 @@ import { ArrayField, Button, CheckboxInput, FieldDescription, FieldError, FieldL
 import { GREY_SCALES, SHADE_STEPS, contrastForeground, contrastRatio, createColorScale, deriveDarkPalette, deriveLightPalette, hexToHSL, hslToString, includedShadeSteps, isThemeHex, presetHints, setColorScaleInclude } from "@bison-lab/tokens";
 import { useCallback, useEffect, useId, useLayoutEffect, useMemo, useRef, useState } from "react";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
-import { Badge, Dialog, Field, Input, KitProvider, Label, Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@bison-lab/admin-ui";
+import { Badge, Button as Button$1, Dialog, Field, Input, KitProvider, Label, Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@bison-lab/admin-ui";
 import { HexColorPicker } from "react-colorful";
 import { createPortal } from "react-dom";
 import { findFont, fontFaceCss, isFontId } from "@bison-lab/fonts";
+import "payload";
 //#region src/admin/color-field.tsx
 const HEX_ERROR = "Enter a six-digit hex colour like #1e3a5f";
 /**
@@ -3004,6 +3005,90 @@ const RoleSlugField = ({ field, path, readOnly }) => {
 	});
 };
 //#endregion
+//#region src/fields/slug.ts
+const SLUG_UNLOCK_WARNING = "This page is live. Changing the address will send visitors from the old URL to the new one.";
+function slugifySegment(segment) {
+	return segment.normalize("NFKD").replace(/\p{M}/gu, "").toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
+}
+/**
+* A stored slug from whatever was typed: NFKD, hyphenated, slash segments
+* kept, so `Café / About Us` becomes `cafe/about-us`.
+*/
+function normalizeSlug(value) {
+	return value.split("/").map(slugifySegment).filter(Boolean).join("/");
+}
+//#endregion
+//#region src/admin/slug-field.tsx
+/**
+* Slug follows the title until first publish. After that it is read-only
+* until Unlock, which warns that the old address will redirect.
+*/
+const SlugField = ({ field, path, readOnly }) => {
+	const { value, setValue, showError, errorMessage } = useField({ path });
+	const { value: unlock, setValue: setUnlock } = useField({ path: "slugUnlock" });
+	const title = useFormFields(([fields]) => fields.title?.value);
+	const slugLocked = Boolean(useFormFields(([fields]) => fields.slugLocked?.value));
+	const locked = Boolean(readOnly) || slugLocked && !unlock;
+	const required = Boolean(field.required);
+	const id = `field-${path.replace(/\./g, "__")}`;
+	useEffect(() => {
+		if (slugLocked || typeof title !== "string") return;
+		const next = normalizeSlug(title);
+		if (next !== (value ?? "")) setValue(next);
+	}, [
+		setValue,
+		slugLocked,
+		title,
+		value
+	]);
+	return /* @__PURE__ */ jsxs("div", {
+		className: [
+			fieldBaseClass,
+			"text",
+			locked && "read-only"
+		].filter(Boolean).join(" "),
+		children: [
+			/* @__PURE__ */ jsx(FieldLabel, {
+				htmlFor: id,
+				label: field.label,
+				required
+			}),
+			/* @__PURE__ */ jsxs("div", {
+				className: `${fieldBaseClass}__wrap`,
+				children: [
+					/* @__PURE__ */ jsx(FieldError, {
+						message: errorMessage,
+						path,
+						showError
+					}),
+					/* @__PURE__ */ jsx("input", {
+						id,
+						type: "text",
+						autoComplete: "off",
+						spellCheck: false,
+						readOnly: locked,
+						disabled: locked,
+						value: value ?? "",
+						onChange: (event) => {
+							if (!locked) setValue(event.target.value);
+						}
+					}),
+					slugLocked && !unlock ? /* @__PURE__ */ jsx(Button$1, {
+						variant: "outline",
+						onClick: () => setUnlock(true),
+						children: "Unlock"
+					}) : null
+				]
+			}),
+			unlock ? /* @__PURE__ */ jsx("p", { children: SLUG_UNLOCK_WARNING }) : null,
+			/* @__PURE__ */ jsx(FieldDescription, {
+				description: field.admin?.description,
+				path
+			})
+		]
+	});
+};
+//#endregion
 //#region src/admin/role-name-field.tsx
 /**
 * Role name. Letters and spaces only, so the hidden slug stays
@@ -3743,6 +3828,6 @@ const AdminNavEntityField = ({ field, path, permissions, readOnly, schemaPath })
 	});
 };
 //#endregion
-export { AdminNav, AdminNavEntityField, AdminNavItemRowLabel, AdminNavRowLabel, AppearanceField, ColorField, ColorScaleField, ContrastReport, DocumentCreateNew, DocumentTitleActions, FeaturesMatrixField, FontField, GreyScaleField, HiddenSaveButton, IdentityFallback, LibraryField, LookField, PairingField, PublishChild, RoleNameField, RoleSlugField, RolesField, RolesGrantsField, RolesMatrixField, RolesRowLabel, SectionHeading, ThemeDocumentControls, ThemeSaveButton, setThemePreviewMode };
+export { AdminNav, AdminNavEntityField, AdminNavItemRowLabel, AdminNavRowLabel, AppearanceField, ColorField, ColorScaleField, ContrastReport, DocumentCreateNew, DocumentTitleActions, FeaturesMatrixField, FontField, GreyScaleField, HiddenSaveButton, IdentityFallback, LibraryField, LookField, PairingField, PublishChild, RoleNameField, RoleSlugField, RolesField, RolesGrantsField, RolesMatrixField, RolesRowLabel, SectionHeading, SlugField, ThemeDocumentControls, ThemeSaveButton, setThemePreviewMode };
 
 //# sourceMappingURL=admin.mjs.map