@justanarthur/payload-www 0.1.1

package/dist/config.d.ts

@@ -0,0 +1,100 @@
+import { Block as Block3, CollectionConfig as CollectionConfig4, Config, GlobalConfig as GlobalConfig3, Plugin } from "payload";
+/**
+* Minimal next-intl routing contract the lib reads. Hosts pass
+* their `defineRouting({...})` result directly; the lib only needs
+* the shape below.
+*
+* `localePrefix` accepts either the simple string form
+* (`'always' | 'as-needed' | 'never'`) or next-intl's verbose
+* `LocalePrefixConfigVerbose` shape (`{ mode, prefixes? }`). The lib
+* normalizes both to a string `mode` internally.
+*/
+type LocalePrefixValue = "always" | "as-needed" | "never" | {
+	mode?: "always" | "as-needed" | "never";
+};
+type PageRouting = {
+	locales: readonly string[];
+	defaultLocale: string;
+	localePrefix?: LocalePrefixValue;
+	/** Optional human-readable labels per locale (used by the
+	* `<LocaleSwitcher>`). Falls back to the locale code when missing.
+	* Not part of next-intl's `defineRouting` shape — the host extends
+	* its routing object to include it (e.g. via a type assertion). */
+	labels?: Record<string, string>;
+};
+type WWWConfigOptions = {
+	/**
+	* Locales the host uses. First entry is the default locale
+	* (used for translation source-of-truth and the home-page path).
+	* The list drives hreflang alternates, sitemap, and the per-locale
+	* revalidation tag suffix.
+	*/
+	locales: string[];
+	/**
+	* The host's next-intl routing config (the value returned from
+	* `defineRouting({...})`). When passed, `locales`, `defaultLocale`,
+	* and `localePrefix` are read from this object instead of the
+	* legacy `locales: string[]` field. `localePrefix` is normalized
+	* to the simple string form internally — next-intl's verbose
+	* `{ mode, prefixes? }` shape is accepted and reduced to `mode`.
+	*/
+	routing?: PageRouting;
+	/**
+	* Blocks the Pages collection accepts.
+	*/
+	blocks: Block3[];
+	/**
+	* Collection slugs the Header / Footer nav `link` fields can
+	* reference. Defaults to `['pages']` (the lib's Pages collection).
+	* Pass a different list when your host has additional linkable
+	* collections.
+	*/
+	linkRelationTo?: string[];
+	/**
+	* Register the lib's Posts collection. Default: `true`. The
+	* translator plugin's default `collections` list is
+	* `['pages', 'posts']`; pass `false` here to opt out and either
+	* define your own posts-like collection or drop the translator.
+	*/
+	registerPosts?: 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
+	* translation in this project), add a second `seoPlugin({...})`
+	* call for posts, or layer on a `formBuilderPlugin(...)`.
+	*/
+	defaultPlugins?: (defaults: Plugin[]) => Plugin[];
+};
+type WWWConfigApi = {
+	withWWWConfig: (config: WWWInputConfig) => Promise<Config> | Config;
+};
+type WWWInputConfig = Omit<Config, "collections" | "globals"> & {
+	collections: ((args: {
+		defaultCollections: CollectionConfig4[];
+	}) => CollectionConfig4[]) | CollectionConfig4[];
+	globals: ((args: {
+		defaultGlobals: GlobalConfig3[];
+	}) => GlobalConfig3[]) | GlobalConfig3[];
+};
+/**
+* Build the lib's data-config API surface, configured for a specific host.
+*
+* Hosts call this once with their `locales` and `blocks`; the returned
+* object is **safe to import from a Node entrypoint** such as
+* `payload.config.ts` — it only contains Payload collection / global
+* factories and the `withWWWConfig` composer.
+*
+* The lib applies three plugins by default: `seoPlugin` (Pages + meta tab),
+* `imageHashPlugin` (Blurhash/Thumbhash on uploads), and `translator`
+* (auto-translation workflow). Use the `defaultPlugins` callback to
+* drop or extend the list.
+*
+* For the App Router rendering side, import from the lib's render
+* subpaths:
+*
+*   import { createCollectionPageExports } from '@justanarthur/payload-www/render-pages'
+*   import { createPreviewHandler, createSitemapFile } from '@justanarthur/payload-www/render-utils'
+*/
+declare function createWWWConfig(options: WWWConfigOptions): WWWConfigApi;
+export { createWWWConfig as default, createWWWConfig, WWWInputConfig, WWWConfigOptions, WWWConfigApi };