@justanarthur/payload-www 0.1.1

package/dist/fields.d.ts

@@ -0,0 +1,36 @@
+import { Field, GroupField } from "payload";
+type LinkAppearances = "default" | "outline";
+declare const appearanceOptions: Record<LinkAppearances, {
+	label: string;
+	value: string;
+}>;
+type LinkOptions = {
+	appearances?: LinkAppearances[] | false;
+	disableLabel?: boolean;
+	/**
+	* Collection slugs the link can reference. Payload 3.85 rejects
+	* empty arrays, so the lib defaults to `['pages']` (its own Pages
+	* collection). Hosts that reference different collections pass
+	* their own list.
+	*/
+	relationTo?: string[];
+	/** Mark the text fields as `localized: true`. */
+	localized?: boolean;
+	/** Deep-merge into the resulting group. */
+	overrides?: Partial<GroupField>;
+	/** Legacy alias for the host's custom field overrides. */
+	linkOverrides?: Partial<GroupField>;
+};
+declare const link: (options?: LinkOptions) => Field;
+import { Field as Field2 } from "payload";
+declare const linkGroup: (options?: LinkOptions) => Field2;
+import { Field as Field_14espm } from "payload";
+declare const _default: {
+	link: (options?: LinkOptions) => Field_14espm;
+	linkGroup: (options?: LinkOptions) => Field_14espm;
+	appearanceOptions: Record<LinkAppearances, {
+		label: string;
+		value: string;
+	}>;
+};
+export { linkGroup, link, _default as default, appearanceOptions, LinkOptions, LinkAppearances };

package/dist/fields.js

@@ -0,0 +1,134 @@
+
+var __defProp = Object.defineProperty;
+var __returnValue = (v) => v;
+function __exportSetter(name, newValue) {
+  this[name] = __returnValue.bind(null, newValue);
+}
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: __exportSetter.bind(all, name)
+    });
+};
+var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
+
+// src/config/constants.ts
+var PAGES_RENDER_PATH = "@justanarthur/payload-www/render-pages#PagesPage";
+var POSTS_RENDER_PATH = "@justanarthur/payload-www/render-pages#PostsPage";
+var HEADER_RENDER_PATH = "@justanarthur/payload-www/render-pages#HeaderPage";
+var FOOTER_RENDER_PATH = "@justanarthur/payload-www/render-pages#FooterPage";
+var LIVE_PREVIEW_LISTENER_PATH = "@justanarthur/payload-www/render-components#LivePreviewListener";
+var PAGES_SLUG = "pages";
+var POSTS_SLUG = "posts";
+var STATIC_PAGES_SLUG = "staticPages";
+
+// src/core/fields/link.ts
+var appearanceOptions = {
+  default: { label: "Default", value: "default" },
+  outline: { label: "Outline", value: "outline" }
+};
+var link = (options = {}) => {
+  const {
+    appearances,
+    disableLabel = false,
+    relationTo = [PAGES_SLUG],
+    localized = false,
+    overrides = {}
+  } = options;
+  const result = {
+    name: "link",
+    type: "group",
+    admin: { hideGutter: true },
+    fields: [
+      {
+        type: "row",
+        fields: [
+          {
+            name: "type",
+            type: "radio",
+            admin: { layout: "horizontal", width: "50%" },
+            defaultValue: "reference",
+            options: [
+              { label: "Internal link", value: "reference" },
+              { label: "Custom URL", value: "custom" }
+            ]
+          },
+          {
+            name: "newTab",
+            type: "checkbox",
+            admin: { style: { alignSelf: "flex-end" }, width: "50%" },
+            label: "Open in new tab"
+          }
+        ]
+      }
+    ]
+  };
+  const linkTypes = [
+    {
+      name: "reference",
+      type: "relationship",
+      admin: { condition: (_, siblingData) => siblingData?.type === "reference" },
+      label: "Document to link to",
+      relationTo,
+      required: true,
+      localized
+    },
+    {
+      name: "url",
+      type: "text",
+      admin: { condition: (_, siblingData) => siblingData?.type === "custom" },
+      label: "Custom URL",
+      required: true,
+      localized
+    }
+  ];
+  if (!disableLabel) {
+    result.fields.push({
+      type: "row",
+      fields: [
+        ...linkTypes,
+        {
+          name: "label",
+          type: "text",
+          admin: { width: "50%" },
+          label: "Label",
+          required: true,
+          localized
+        }
+      ]
+    });
+  } else {
+    result.fields = [...result.fields, ...linkTypes];
+  }
+  if (appearances !== false) {
+    const opts = appearances ? appearances.map((a) => appearanceOptions[a]) : [appearanceOptions.default, appearanceOptions.outline];
+    result.fields.push({
+      name: "appearance",
+      type: "select",
+      admin: { description: "Choose how the link should be rendered." },
+      defaultValue: "default",
+      options: opts
+    });
+  }
+  return { ...result, ...overrides };
+};
+
+// src/core/fields/linkGroup.ts
+var linkGroup = (options = {}) => ({
+  name: "links",
+  type: "array",
+  fields: [link(options)],
+  admin: { initCollapsed: true }
+});
+
+// src/exports/fields.ts
+var fields_default = { link, linkGroup, appearanceOptions };
+export {
+  linkGroup,
+  link,
+  fields_default as default,
+  appearanceOptions
+};

package/dist/globals.d.ts

@@ -0,0 +1,48 @@
+import { GlobalConfig } from "payload";
+type CreateHeaderGlobalOptions = {
+	/**
+	* Optional override for the `custom.path` Payload uses to resolve
+	* the header's render module. Default: the lib's `HEADER_RENDER_PATH`.
+	*/
+	renderPath?: string;
+	/**
+	* Collection slugs the nav's link fields can reference. Required
+	* by Payload 3.85 — empty `relationTo` arrays are rejected.
+	* Defaults to `['pages']` (the lib's Pages collection). Pass a
+	* different list when your host has additional linkable collections.
+	*/
+	linkRelationTo?: string[];
+};
+/**
+* Build the Header global. The lib's default shape: a `nav` blocks
+* field with two block types — `navColumn` (a titled group of links)
+* and `navItem` (a single link).
+*/
+declare const createHeaderGlobal: (options?: CreateHeaderGlobalOptions) => GlobalConfig;
+import { GlobalConfig as GlobalConfig2 } from "payload";
+type CreateFooterGlobalOptions = {
+	/**
+	* Optional override for the `custom.path` Payload uses to resolve
+	* the footer's render module. Default: the lib's `FOOTER_RENDER_PATH`.
+	*/
+	renderPath?: string;
+	/**
+	* Collection slugs the nav's link fields can reference. Required
+	* by Payload 3.85 — empty `relationTo` arrays are rejected.
+	* Defaults to `['pages']` (the lib's Pages collection). Pass a
+	* different list when your host has additional linkable collections.
+	*/
+	linkRelationTo?: string[];
+};
+/**
+* Build the Footer global. The lib's default shape mirrors the
+* Header: a `nav` blocks field with `navColumn` (a titled group of
+* links) and `navItem` (a single link) blocks.
+*/
+declare const createFooterGlobal: (options?: CreateFooterGlobalOptions) => GlobalConfig2;
+import { GlobalConfig as GlobalConfig_fuin17 } from "payload";
+declare const _default: {
+	createHeaderGlobal: (options?: CreateHeaderGlobalOptions) => GlobalConfig_fuin17;
+	createFooterGlobal: (options?: CreateFooterGlobalOptions) => GlobalConfig_fuin17;
+};
+export { _default as default, createHeaderGlobal, createFooterGlobal, CreateHeaderGlobalOptions, CreateFooterGlobalOptions };

package/dist/globals.js

@@ -0,0 +1,228 @@
+
+var __defProp = Object.defineProperty;
+var __returnValue = (v) => v;
+function __exportSetter(name, newValue) {
+  this[name] = __returnValue.bind(null, newValue);
+}
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: __exportSetter.bind(all, name)
+    });
+};
+var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
+
+// src/config/constants.ts
+var PAGES_RENDER_PATH = "@justanarthur/payload-www/render-pages#PagesPage";
+var POSTS_RENDER_PATH = "@justanarthur/payload-www/render-pages#PostsPage";
+var HEADER_RENDER_PATH = "@justanarthur/payload-www/render-pages#HeaderPage";
+var FOOTER_RENDER_PATH = "@justanarthur/payload-www/render-pages#FooterPage";
+var LIVE_PREVIEW_LISTENER_PATH = "@justanarthur/payload-www/render-components#LivePreviewListener";
+var PAGES_SLUG = "pages";
+var POSTS_SLUG = "posts";
+var STATIC_PAGES_SLUG = "staticPages";
+
+// src/core/fields/link.ts
+var appearanceOptions = {
+  default: { label: "Default", value: "default" },
+  outline: { label: "Outline", value: "outline" }
+};
+var link = (options = {}) => {
+  const {
+    appearances,
+    disableLabel = false,
+    relationTo = [PAGES_SLUG],
+    localized = false,
+    overrides = {}
+  } = options;
+  const result = {
+    name: "link",
+    type: "group",
+    admin: { hideGutter: true },
+    fields: [
+      {
+        type: "row",
+        fields: [
+          {
+            name: "type",
+            type: "radio",
+            admin: { layout: "horizontal", width: "50%" },
+            defaultValue: "reference",
+            options: [
+              { label: "Internal link", value: "reference" },
+              { label: "Custom URL", value: "custom" }
+            ]
+          },
+          {
+            name: "newTab",
+            type: "checkbox",
+            admin: { style: { alignSelf: "flex-end" }, width: "50%" },
+            label: "Open in new tab"
+          }
+        ]
+      }
+    ]
+  };
+  const linkTypes = [
+    {
+      name: "reference",
+      type: "relationship",
+      admin: { condition: (_, siblingData) => siblingData?.type === "reference" },
+      label: "Document to link to",
+      relationTo,
+      required: true,
+      localized
+    },
+    {
+      name: "url",
+      type: "text",
+      admin: { condition: (_, siblingData) => siblingData?.type === "custom" },
+      label: "Custom URL",
+      required: true,
+      localized
+    }
+  ];
+  if (!disableLabel) {
+    result.fields.push({
+      type: "row",
+      fields: [
+        ...linkTypes,
+        {
+          name: "label",
+          type: "text",
+          admin: { width: "50%" },
+          label: "Label",
+          required: true,
+          localized
+        }
+      ]
+    });
+  } else {
+    result.fields = [...result.fields, ...linkTypes];
+  }
+  if (appearances !== false) {
+    const opts = appearances ? appearances.map((a) => appearanceOptions[a]) : [appearanceOptions.default, appearanceOptions.outline];
+    result.fields.push({
+      name: "appearance",
+      type: "select",
+      admin: { description: "Choose how the link should be rendered." },
+      defaultValue: "default",
+      options: opts
+    });
+  }
+  return { ...result, ...overrides };
+};
+
+// src/render/hooks/_shared.ts
+var cachePromise = null;
+function nextCacheImport() {
+  return cachePromise ??= import("next/cache");
+}
+function shouldSkipRevalidate(context) {
+  return Boolean(context?.disableRevalidate);
+}
+async function safeRevalidatePath(payload, path) {
+  try {
+    const { revalidatePath } = await nextCacheImport();
+    revalidatePath(path);
+  } catch (error) {
+    payload.logger.error(`revalidatePath("${path}") failed: ${String(error)}`);
+  }
+}
+async function safeRevalidateTag(payload, tag, profile = "max") {
+  try {
+    const { revalidateTag } = await nextCacheImport();
+    revalidateTag(tag, profile);
+  } catch (error) {
+    payload.logger.error(`revalidateTag("${tag}") failed: ${String(error)}`);
+  }
+}
+
+// src/render/hooks/revalidateGlobal.ts
+function createRevalidateGlobalHook(slug) {
+  return async ({ doc, req: { payload, context, locale } }) => {
+    if (shouldSkipRevalidate(context))
+      return doc;
+    const tags = [`global_${slug}`, `global_${slug}_${locale}`];
+    payload.logger.info?.(`Revalidating global: ${tags.join(", ")}`);
+    for (const tag of tags) {
+      await safeRevalidateTag(payload, tag);
+    }
+    return doc;
+  };
+}
+
+// src/data/collections/globals/Header/config.ts
+var createHeaderGlobal = (options = {}) => {
+  const { renderPath = HEADER_RENDER_PATH, linkRelationTo = [PAGES_SLUG] } = 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 })] }
+    ]
+  };
+  const navItemBlock = {
+    slug: "navItem",
+    fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })]
+  };
+  return {
+    slug: "header",
+    custom: { path: renderPath },
+    access: { read: () => true },
+    fields: [
+      {
+        name: "nav",
+        type: "blocks",
+        required: true,
+        blocks: [navColumnBlock, navItemBlock]
+      }
+    ],
+    hooks: {
+      afterChange: [createRevalidateGlobalHook("header")]
+    }
+  };
+};
+
+// src/data/collections/globals/Footer/config.ts
+var createFooterGlobal = (options = {}) => {
+  const { renderPath = FOOTER_RENDER_PATH, linkRelationTo = [PAGES_SLUG] } = 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 })] }
+    ]
+  };
+  const navItemBlock = {
+    slug: "navItem",
+    fields: [link({ appearances: false, localized: true, relationTo: linkRelationTo })]
+  };
+  return {
+    slug: "footer",
+    custom: { path: renderPath },
+    access: { read: () => true },
+    fields: [
+      {
+        name: "nav",
+        type: "blocks",
+        required: true,
+        blocks: [navColumnBlock, navItemBlock]
+      }
+    ],
+    hooks: {
+      afterChange: [createRevalidateGlobalHook("footer")]
+    }
+  };
+};
+
+// src/exports/globals.ts
+var globals_default = { createHeaderGlobal, createFooterGlobal };
+export {
+  globals_default as default,
+  createHeaderGlobal,
+  createFooterGlobal
+};

package/dist/hooks.d.ts

@@ -0,0 +1,108 @@
+import { CollectionAfterChangeHook, CollectionAfterDeleteHook } from "payload";
+type LocalePrefixMode = "always" | "as-needed" | "never";
+type CreateRevalidateCollectionHookOptions = {
+	/**
+	* The collection's slug. Used in the per-collection tag fired
+	* alongside path invalidation: `collection_<slug>_<id>`.
+	*/
+	collectionSlug: string;
+	/**
+	* URL path prefix for this collection's rendered URLs. Pages use
+	* `''` (mounted at root); Posts use `'/posts'`. Leading slash,
+	* no trailing slash — same convention as
+	* `createSitemapFile.urlPrefixes`.
+	*/
+	urlPathPrefix?: string;
+	/**
+	* Sitemap tag the collection's revalidation hook invalidates on
+	* every save. Defaults to `${collectionSlug}-sitemap`. Pass
+	* `false` to opt out (collections without a sitemap handler).
+	*/
+	sitemapTag?: string | false;
+	/**
+	* Locale prefix mode — mirrors next-intl's `localePrefix`.
+	* Defaults to `'always'` (preserves legacy behavior).
+	*/
+	localePrefix?: LocalePrefixMode;
+	/**
+	* Default locale for `localePrefix: 'as-needed'`. Falls back to
+	* `req.payload.config.localization.defaultLocale` at request time
+	* when omitted.
+	*/
+	defaultLocale?: string;
+	/**
+	* Path invalidation strategy. Default: `'url'` — fans out
+	* `revalidatePath` for every locale × every slug. Set to
+	* `'tag-only'` for collections without a URL (e.g. `staticPages`
+	* — addressed by a `kind` discriminator, not a slug). Tag-only
+	* mode still fires the per-collection tag (via `sitemapTag`) and
+	* the per-id tag (`collection_<slug>_<id>`).
+	*/
+	pathMode?: "url" | "tag-only";
+};
+/**
+* Canonical factory for **all** collection revalidation hooks —
+* Pages, Posts, and any host-defined collection.
+*
+* Behavior:
+*
+* - Fires `revalidatePath` for **every** locale the host has
+*   declared (not just the request locale). The path is
+*   `${prefixFor(locale)}${urlPathPrefix}/${slug}` (or
+*   `${prefixFor(locale)}${urlPathPrefix}` for the home page with
+*   empty slug).
+* - Fires `revalidateTag(sitemapTag, 'max')` on every change /
+*   delete so the sitemap handler sees fresh data.
+* - Fires `revalidateTag('collection_<slug>_<id>', 'max')` so
+*   hosts using `unstable_cache` keyed by id stay fresh.
+* - Handles slug renames while published (fires both old and new
+*   paths across all locales).
+* - Respects `req.context.disableRevalidate` for seed / test
+*   scripts.
+*
+* Use `createRevalidateCollectionHook({ ... })` for any
+* collection. For Pages specifically, the lib still exposes
+* `createRevalidatePageHooks()` as a deprecated alias that
+* delegates to this factory with `collectionSlug: 'pages'` and
+* `urlPathPrefix: ''`.
+*/
+declare function createRevalidateCollectionHook(options: CreateRevalidateCollectionHookOptions): {
+	afterChange: CollectionAfterChangeHook;
+	afterDelete: CollectionAfterDeleteHook;
+};
+type CreateRevalidatePageHooksOptions = Omit<CreateRevalidateCollectionHookOptions, "collectionSlug" | "urlPathPrefix">;
+/**
+* @deprecated Use `createRevalidateCollectionHook({ collectionSlug: 'pages', urlPathPrefix: '' })` instead.
+* Kept so hosts that imported this name directly don't break — the
+* alias delegates to the canonical factory with the Pages preset.
+*/
+declare const createRevalidatePageHooks: (opts?: CreateRevalidatePageHooksOptions) => {
+	afterChange: CollectionAfterChangeHook;
+	afterDelete: CollectionAfterDeleteHook;
+};
+import { GlobalAfterChangeHook } from "payload";
+/**
+* Build a tag-based revalidation hook for a global. Fires two tags
+* after a save:
+*
+* - `global_${slug}` — invalidates the lib's `getCachedGlobal` cache
+*   and any host caches that key by slug alone.
+* - `global_${slug}_${locale}` — invalidates per-locale cache slots
+*   for hosts that key by `[slug, locale]`.
+*
+* The hook fires both so the lib's single-slot cache and the
+* per-locale pattern both stay fresh regardless of which the host
+* uses.
+*/
+declare function createRevalidateGlobalHook(slug: string): GlobalAfterChangeHook;
+import { CollectionAfterChangeHook as CollectionAfterChangeHook_qdlahd } from "payload";
+import { CollectionAfterDeleteHook as CollectionAfterDeleteHook_jscwy4 } from "payload";
+declare const _default: {
+	createRevalidateCollectionHook: typeof createRevalidateCollectionHook;
+	createRevalidatePageHooks: (opts?: CreateRevalidatePageHooksOptions) => {
+		afterChange: CollectionAfterChangeHook_qdlahd;
+		afterDelete: CollectionAfterDeleteHook_jscwy4;
+	};
+	createRevalidateGlobalHook: typeof createRevalidateGlobalHook;
+};
+export { _default as default, createRevalidatePageHooks, createRevalidateGlobalHook, createRevalidateCollectionHook, CreateRevalidatePageHooksOptions, CreateRevalidateCollectionHookOptions };