@pro-laico/core

The shared foundation every Atomic Payload package builds on: end-to-end type safety, tag-based caching and revalidation, JSON-schema type generation, and reusable admin and frontend building blocks.

@pro-laico/core is the shared foundation the rest of Atomic Payload is built on. You rarely install it on its own (the other plugins bring it along), but it's the common ground they all rely on: end-to-end type safety, tag-based caching with correct revalidation, and a set of reusable fields, hooks, and UI pieces. This page is mostly a reference for what it provides.

Installation

pnpm add @pro-laico/core

npm install @pro-laico/core

yarn add @pro-laico/core

Installed for you: this package's dependencies (including server-only). Provide yourself (peers): payload, next, react, and @payloadcms/ui come with a Payload + Next.js app; also install @base-ui/react (the UI primitives) and, if you use live preview, @payloadcms/live-preview-react.

Setup

You usually get @pro-laico/core transitively, and the atomic-payload template wires up everything below for you. When you reach for it directly, these are the pieces worth knowing.

Revalidate caches with `revalidationPlugin`

Every @pro-laico/* collection and global bakes its own cache-revalidation hooks, so they need no wiring. revalidationPlugin covers the gap: it attaches the core revalidation hooks (post-commit afterChange, plus afterDelete) to the collection and global slugs you name, for collections a third-party plugin registers (for example the form builder's forms / form-submissions). Add it after the plugin that registers those slugs:

import { buildConfig } from 'payload'
import { revalidationPlugin } from '@pro-laico/core'
import { formBuilderPlugin } from '@payloadcms/plugin-form-builder'

export default buildConfig({
  plugins: [
    formBuilderPlugin({ /* ... */ }),
    // After the plugin that registers them, so the slugs already exist:
    revalidationPlugin({ collectionSlugs: ['forms', 'form-submissions'] }),
  ],
})

The dispatchers self-select by slug and no-op when no handler matches, so an unknown slug is harmless. The atomic-payload template wires its plugins as a flat Plugin[] and uses this for the form builder's collections.

Generate accurate block types with `jsonSchemaPlugin`

jsonSchemaPlugin extends payload generate:types so block fields get accurate generated types. Add it to your plugins array, giving it the block lists each @pro-laico plugin contributes so the generated types stay precise. The template registers it this way.

Generate types with the augmentation step

@pro-laico/core includes a core-augment-types command that writes a payload-types.augment.d.ts file next to your generated payload-types.ts. It connects your project's concrete generated types into the shared type system, so every plugin's schema stubs resolve to your real shapes instead of permissive fallbacks. Chain it after Payload's own type generation, exactly what the template's generate:types script does:

{
  "scripts": {
    "generate:types": "payload generate:types && core-augment-types"
  }
}

The generated payload-types.augment.d.ts is rewritten every time you run this, so add it to your .gitignore next to the rest of the generated types:

# .gitignore — generated by payload generate:types
src/payload-types.ts
src/payload-types.augment.d.ts

The rest of the package (fields, hooks, cache helpers, URL and metadata utilities, and the admin / frontend components) is imported directly where you need it. See the Exports table for the full surface and the import path for each item.

Options

`revalidationPlugin(options?)`

Prop

Type

All options at their defaults, as a working starting point:

revalidationPlugin({
  enabled: true,
  collectionSlugs: [],
  deleteCollectionSlugs: [],
  globalSlugs: [],
})

`jsonSchemaPlugin(options)`

Prop

Type

All options at their defaults, with the block lists wired the way the template does it:

jsonSchemaPlugin({
  enabled: true,
  toJSONSchemaExtensions, // required (from @pro-laico/zap)
  generateBlocksType, // required (from @pro-laico/zap)
  blocks: {
    ChildBlocks: ChildBlockType.options, // required
    BackdropChildren: BackdropChildSlug.options, // optional
    ActionBlocks: ActionBlockType.options, // required
    FormRateLimitBlocks: FormRateLimitBlockType.options, // required
    FormSanitationBlocks: FormSanitationBlockType.options, // required
    FormValidationBlocks: FormValidationBlockType.options, // required
    InputSanitationBlocks: InputSanitationBlockType.options, // required
    InputValidationBlocks: InputValidationBlockType.options, // required
  },
  // extraDefinitions is unset by default
})

Environment variables

@pro-laico/core reads these at runtime. Most have sensible fallbacks; set the ones the features you use depend on.

Variable	Required?	Purpose
`NEXT_PUBLIC_SERVER_URL`	No	The site's base URL, used by `getServerSideURL` for absolute links and metadata. Falls back to the Vercel production URL, then `http://localhost:3000`.
`VERCEL_PROJECT_PRODUCTION_URL`	No	Set by Vercel. Used as the base URL when `NEXT_PUBLIC_SERVER_URL` isn't set.
`PREVIEW_SECRET`	For previews	Validates draft-preview requests: `generateLivePreviewPath` appends it to the preview URL and the preview route handler rejects mismatches.
`VERCEL_DEPLOY_WEBHOOK_URL`	For the deploy control	The deploy hook the admin "trigger deploy" control (the site triggers component) posts to.
`LOGS`	No	Set to `true` to print the package's cache, revalidation, and preview debug logs.

Caching & revalidation

@pro-laico/core ships the caching machinery the rest of Atomic Payload reads through, but no data getters of its own. The pieces it owns:

withCache and mt (from @pro-laico/core/cache): the primitive every package getter wraps its fetch with, plus the merge-tags helper that builds the dependency-tag strings. Server-only.
The revalidation hooks and factories (revalidateCacheCollection, revalidateCacheCollectionAfterChange, revalidateCacheOnDelete, revalidateCacheGlobalAfterChange, and the createRevalidateCache* factories): revalidationPlugin attaches them to the slugs you name so saving or deleting a document revalidates the matching tags.
revalidateTag: the safe next/cache wrapper used in server actions and the admin deploy control.

See Caching & revalidation for how the tags are derived and how a read-side tag matches the revalidate side.

Exports

@pro-laico/core is large and spans several import subpaths, so its surface is grouped below by what each piece does and where it comes from.

Plugins & composition

Export

Type

revalidationPluginplugin

Attaches the cache-revalidation hooks (afterChange + afterDelete) to the collection and global slugs you list. The @pro-laico/* collections and globals bake these hooks themselves, so use this for third-party collections (e.g. the form builder's forms / form-submissions). Default and named export.

Parameters

options?:RevalidationPluginOptionsSee the Options table above (collectionSlugs, deleteCollectionSlugs, globalSlugs, enabled). Defaults to an empty config, which is a no-op.

Returns

PluginA Payload config plugin you add to buildConfig({ plugins: [...] }), after the plugin that registers the target slugs.

Example

import { buildConfig } from 'payload'import { revalidationPlugin } from '@pro-laico/core'import { formBuilderPlugin } from '@payloadcms/plugin-form-builder'export default buildConfig({plugins: [  formBuilderPlugin({ /* ... */ }),  revalidationPlugin({ collectionSlugs: ['forms', 'form-submissions'] }),],})

Location

@pro-laico/core

jsonSchemaPluginplugin

Extends payload generate:types with accurate JSON-schema definitions for block fields. Default and named export.

Parameters

options:JSONSchemaPluginOptionsSee the Options table above. toJSONSchemaExtensions, generateBlocksType, and blocks are required; pass each plugin's block-slug .options arrays.

Returns

PluginA Payload config plugin that appends the schema extension to config.typescript.schema.

Example

import { jsonSchemaPlugin } from '@pro-laico/core'import { generateBlocksType, toJSONSchemaExtensions } from '@pro-laico/zap'import { ChildBlockType } from '@pro-laico/atomic/children/zap'import { ActionBlockType } from '@pro-laico/atomic/actions/zap'export const jsonSchemaPluginConfig = jsonSchemaPlugin({toJSONSchemaExtensions,generateBlocksType,blocks: {  ChildBlocks: ChildBlockType.options,  ActionBlocks: ActionBlockType.options,  // ...the form / input block lists},})

Location

@pro-laico/core

createJSONSchemaExtensionsfunction

Builds the schema-extension function jsonSchemaPlugin appends. Call it directly to wire schema generation onto config.typescript.schema by hand instead of through the plugin.

Parameters

options:CreateJSONSchemaExtensionsOptionsSame toJSONSchemaExtensions, generateBlocksType, blocks, and optional extraDefinitions the plugin takes (minus enabled).

Returns

(args: { jsonSchema }) => JSONSchema4A schema-extension function you push onto config.typescript.schema.

Example

import { buildConfig } from 'payload'import { createJSONSchemaExtensions } from '@pro-laico/core'import { generateBlocksType, toJSONSchemaExtensions } from '@pro-laico/zap'const schemaExtension = createJSONSchemaExtensions({toJSONSchemaExtensions,generateBlocksType,blocks: { /* ...the block-slug lists... */ },})export default buildConfig({typescript: { schema: [schemaExtension] },})

Location

@pro-laico/core

Fields

Export

Type

slugFieldfield

Factory for a paired slug + slugLock field set with the auto-formatting hook attached. Returns both fields as a tuple you spread into a collection.

Parameters

slugPath:stringThe admin component path your project provides for the custom Slug UI (e.g. SlugPath, or your own).

fieldToUse?:stringThe field the slug is formatted from. Defaults to title.

overrides?:{ slugOverrides?, checkboxOverrides? }Partial field overrides merged onto the slug and slugLock fields.

Returns

[TextField, CheckboxField]The slug field and its hidden slugLock checkbox.

Example

import type { CollectionConfig } from 'payload'import { slugField, SlugPath } from '@pro-laico/core'export const Pages: CollectionConfig = {slug: 'pages',fields: [  { name: 'title', type: 'text' },  ...slugField(SlugPath, 'title'),],}

Location

@pro-laico/core

StorageTabfield

Factory for the admin Storage tab holding read-only JSON fields for the generated atomic classes, forms, and actions.

Parameters

args?:{ filter?: ('classes' | 'forms' | 'actions')[] }Limit which storage groups the tab renders. Defaults to all three.

Returns

TabAsFieldA tab field you add to a collection or global fields array.

Example

import { StorageTab } from '@pro-laico/core'export const Pages = {slug: 'pages',fields: [  { type: 'tabs', tabs: [/* your content tabs */] },  StorageTab(),],}

Location

@pro-laico/core

DevModeFieldfield

Factory for a checkbox that surfaces developer-only controls in the admin. Takes no arguments.

Returns

CheckboxFieldA devMode checkbox field.

Example

import { DevModeField } from '@pro-laico/core'const fields = [DevModeField()]

Location

@pro-laico/core

TestPathFieldfield

A relationship field for the live-preview test path, bound to the pages collection. Equivalent to createTestPathField(); use createTestPathField(slug) for a non-default pages slug.

Location

@pro-laico/core

createTestPathFieldfunction

Factory for the live-preview testPath relationship field, bound to the pages collection slug you pass.

Parameters

pagesSlug?:stringThe pages collection slug the relationship points at. Defaults to pages.

Returns

RelationshipFieldA testPath relationship field for that pages slug.

Example

import { createTestPathField } from '@pro-laico/core'const fields = [createTestPathField('docs')]

Location

@pro-laico/core

UniqueTitleFieldfield

Factory for a required, unique title text field.

Parameters

defaultValue?:stringThe title default. Defaults to New Title.

Returns

TextFieldA unique title text field.

Example

import { UniqueTitleField } from '@pro-laico/core'const fields = [UniqueTitleField('Untitled')]

Location

@pro-laico/core

ActiveFieldfield

Factory for the reusable active / enabled checkbox, pre-wired with the active APF flag.

Parameters

args?:Partial<APArgs<'checkbox'>>Field overrides (label, admin, defaultValue, …) merged onto the base active field.

Returns

CheckboxFieldAn active checkbox field.

Example

import { ActiveField } from '@pro-laico/core'const fields = [ActiveField({ defaultValue: false })]

Location

@pro-laico/core

APFieldfunction

Wraps a Payload field config to add Atomic Payload Functions (APF) behavior, so the field can drive configurable block behavior. The building block ActiveField and the other APF fields are built on.

Parameters

args:APArgs<'text' | 'select' | 'number' | 'textarea' | 'checkbox'>A field config plus an apf array naming the functions it drives.

Returns

FieldThe field config with the APF admin components and hooks wired in.

Example

import { APField } from '@pro-laico/core'const activeField = APField({type: 'checkbox',name: 'active',apf: ['active'],})

Location

@pro-laico/core

generateAPFFieldsfunction

Builds the hidden, virtual APF storage checkbox fields for the named functions. Add the result to any collection whose documents run APF behavior.

Parameters

apFunctions:APFunction[]The function names to generate storage fields for (e.g. active, form, page).

Returns

CheckboxField[]The virtual APF storage fields.

Example

import { generateAPFFields } from '@pro-laico/core'const fields = [...generateAPFFields(['active', 'page'])]

Location

@pro-laico/core

runAPFfunction

Reads whether an APF was marked changed for a document in the current request context. Call it from a hook to branch on whether a given function ran.

Parameters

args:{ context, id, apf }The request context, the document id, and the apf function name to check.

Returns

booleanTrue when the per-id/apf flag is set for the request.

Example

import { runAPF } from '@pro-laico/core'// inside an afterChange hook:if (runAPF({ context, id: doc.id, apf: 'page' })) {// the page APF ran for this save}

Location

@pro-laico/core

Hooks

Export

Type

revalidate hooksfunction

The ready-bound collection and global revalidation hooks (revalidateCacheCollection, revalidateCacheCollectionAfterChange, revalidateCacheOnDelete, revalidateCacheGlobalAfterChange), wired for you by revalidationPlugin. They dispatch to a default per-slug handler map that matches the template's collections.

Location

@pro-laico/core

createRevalidateCache* factoriesfunction

Bind your own slug-to-handler map: createRevalidateCache (beforeChange), createRevalidateCacheAfterChange (afterChange, preferred for plain collections), and createRevalidateCacheOnDelete (afterDelete). Each takes a { [slug]: handler } record and returns the matching Payload hook.

Parameters

handlers:Record<string, (ctx) => void | Promise<void>>Maps a collection slug to the revalidation handler that runs for its writes.

Returns

CollectionBeforeChangeHook | CollectionAfterChangeHook | CollectionAfterDeleteHookA hook that dispatches to the matching slug handler (and skips while seeding).

Example

import type { CollectionConfig } from 'payload'import { createRevalidateCacheAfterChange, revalidateTag } from '@pro-laico/core'const revalidate = createRevalidateCacheAfterChange({articles: async ({ data }) => {  await revalidateTag('article', data?.slug)},})export const Articles: CollectionConfig = {slug: 'articles',hooks: { afterChange: [revalidate] },fields: [/* ... */],}

Location

@pro-laico/core

updateHrefHookfunction

A field hook that keeps a document href in sync with its latest breadcrumb as its slug or parents change. Attach it to an href field's beforeChange.

Example

import { updateHrefHook } from '@pro-laico/core'const hrefField = {name: 'href',type: 'text',hooks: { beforeChange: [updateHrefHook] },}

Location

@pro-laico/core

updatePublishedAtHookfunction

A field hook that stamps publishedAt the first time a document is published. Attach it to a date field's beforeChange.

Example

import { updatePublishedAtHook } from '@pro-laico/core'const publishedAtField = {name: 'publishedAt',type: 'date',hooks: { beforeChange: [updatePublishedAtHook] },}

Location

@pro-laico/core

URL & metadata helpers

Export

Type

getServerSideURLfunction

Resolves the site base URL on the server. Reads NEXT_PUBLIC_SERVER_URL, then the Vercel production URL, then falls back to http://localhost:3000. Takes no arguments.

Returns

stringThe absolute base URL for the current environment.

Example

import { getServerSideURL } from '@pro-laico/core'// in a server component or sitemap route:const canonical = `${getServerSideURL()}/about`

Location

@pro-laico/core

GenerateMetaDatafunction

Produces a Next.js Metadata object from a page's meta fields and the site fallbacks (title, description, Open Graph image, favicons, robots).

Parameters

args:{ page?, siteMetadata? }The page meta slice and the site-wide fallback metadata. Both are structural shapes, so any doc carrying the expected fields works.

Returns

MetadataA finished Next.js Metadata object to return from generateMetadata.

Example

import { GenerateMetaData } from '@pro-laico/core'// app/(frontend)/[slug]/page.tsxexport async function generateMetadata({ params }) {const page = await getPage(params.slug)const siteMetadata = await getSiteMetadata()return GenerateMetaData({ page, siteMetadata })}

Location

@pro-laico/core

generateLivePreviewPathfunction

Builds the URL Payload's admin live-preview iframe should hit. Pass it as a collection's admin.livePreview.url. The host project must also mount the /next/preview route handler.

Parameters

args:{ data, req }The in-flight document data and the Payload req, as Payload passes them to the live-preview URL builder.

options?:{ pagesSlug?: string; fallbackPath?: string }Override the pages collection slug (pagesSlug, defaults to pages) and the path the preview falls back to when the document has no resolvable href or testPath (fallbackPath, defaults to /testing). Set fallbackPath to point a global-like document or a single-page site at a fixed page, e.g. (args) => generateLivePreviewPath(args, { fallbackPath: "/" }).

Returns

Promise<string>The absolute preview URL (falls back to fallbackPath, default /testing).

Example

import { generateLivePreviewPath } from '@pro-laico/core'export const Pages = {slug: 'pages',admin: {  livePreview: { url: generateLivePreviewPath },},}

Location

@pro-laico/core

Utilities

Export

Type

mergeCollectionfunction

Merge a partial override onto a base collection config without clobbering nested config. access / admin shallow-merge, fields append, hooks merge per-phase. The composition helper the plugins use internally to let you extend their collections.

Parameters

base:CollectionConfigThe default collection to extend.

override?:Partial<CollectionConfig>Your additions. When undefined, base is returned unchanged.

Returns

CollectionConfigThe merged collection.

Example

import { mergeCollection } from '@pro-laico/core'const Pages = mergeCollection(basePages, {admin: { group: 'Content' },fields: [{ name: 'subtitle', type: 'text' }],})

Location

@pro-laico/core

mergeGlobalfunction

The global-config counterpart of mergeCollection (globals have no upload). Shallow-merges access / admin, appends fields, merges hooks per-phase.

Parameters

base:GlobalConfigThe default global to extend.

override?:Partial<GlobalConfig>Your additions. When undefined, base is returned unchanged.

Returns

GlobalConfigThe merged global.

Example

import { mergeGlobal } from '@pro-laico/core'const Settings = mergeGlobal(baseSettings, {fields: [{ name: 'announcement', type: 'text' }],})

Location

@pro-laico/core

mergeHooksfunction

Additively merge two Payload hook maps: each per-phase array in extra is appended after the base array. Works for collection, global, and field hooks.

Parameters

base:TThe base hooks object.

extra?:THooks to append per phase. When undefined, base is returned unchanged.

Returns

TThe merged hooks map (base hooks run before extra within each phase).

Example

import { mergeHooks } from '@pro-laico/core'const hooks = mergeHooks({ beforeChange: [baseHook] },{ beforeChange: [myHook], afterDelete: [cleanup] },)

Location

@pro-laico/core

deepMergefunction

A deep object merge utility. Recursively merges source onto target, returning a new object.

Parameters

target:TThe base object.

source:RThe object whose values win on conflict.

Returns

TA new deeply-merged object.

Example

import { deepMerge } from '@pro-laico/core'const config = deepMerge(defaults, overrides)

Location

@pro-laico/core

sanitizeDatafunction

Recursively removes undefined, null, empty arrays, and empty objects without mutating the input (rich-text children are left intact). Use it before passing Payload data to a client component.

Parameters

incomingData:TThe data to clean.

Returns

TA cleaned clone of the input.

Example

import { sanitizeData } from '@pro-laico/core'const clean = sanitizeData(doc)return <ClientBlock data={clean} />

Location

@pro-laico/core

string helpersfunction

toTitleCase and toKebabCase string-casing helpers, each taking a string and returning the recased string.

Parameters

value:stringThe string to recase.

Returns

stringThe recased string.

Example

import { toKebabCase, toTitleCase } from '@pro-laico/core'toTitleCase('hero block') // 'Hero Block'toKebabCase('Hero Block') // 'hero-block'

Location

@pro-laico/core

manualLoggerfunction

A small tagged logger used across the packages. Colorizes by tag ([INFO], [WARNING], [ERROR], …) and only prints when the LOGS env var is true.

Parameters

message:stringThe message, optionally prefixed with a recognized tag.

Returns

voidLogs to the console; returns nothing.

Example

import { manualLogger } from '@pro-laico/core'manualLogger('[INFO] Regenerated stylesheet')

Location

@pro-laico/core

revalidateTagfunction

A safe wrapper around Next.js revalidateTag, with the cross-tag fan-out the workspace relies on (saving pages also revalidates sitemap, etc.). Marked use server, so it is callable from a server action.

Parameters

tag:stringThe primary cache tag to revalidate.

id?:stringAn id to scope the tag to (id-bound entries like image / page).

draft?:booleanRevalidate the draft variant.

Returns

Promise<void>Revalidates the derived tags (and, for some tags, their dependents).

Example

'use server'import { revalidateTag } from '@pro-laico/core'export async function refreshPages() {await revalidateTag('pages', false)}

Location

@pro-laico/core

Cache

Export

Type

withCachefunction

The caching primitive every package getter wraps its fetch with. Derives the unstable_cache key and dependency tags from a tag, id, and draft flag, so read-side tags match the revalidate side. Subpath-only because it imports server-only.

Parameters

fetcher:() => Promise<T>The data fetch to cache (typically a Local API read).

options:WithCacheOptionstag (required), optional tid (id), draft, and extraTags for cross-tag dependencies.

Returns

Promise<T>The fetcher result, cached and tagged.

Example

import { withCache } from '@pro-laico/core/cache'import { getPayloadInstance } from '@pro-laico/core/payload'export const getCachedDesignSet = (draft: boolean) =>withCache(  async () => {    const payload = await getPayloadInstance()    const { docs } = await payload.find({ collection: 'designSet', where: { active: { equals: true } }, draft })    return docs[0]  },  { tag: 'designSet', draft },)

Location

@pro-laico/core/cache

mtfunction

Merge-tags helper that joins a tag, id, and draft flag into a single colon-delimited dependency-tag string (skipping empty parts). Used by withCache and when a getter needs extra cross-tag dependencies.

Parameters

stringArray:(string | number | undefined)[]The parts to join (empty / nullish parts are dropped).

Returns

stringThe colon-joined tag string (e.g. image:42:draft).

Example

import { mt } from '@pro-laico/core/cache'mt(['image', id, draft ? 'draft' : undefined]) // 'image:42:draft'

Location

@pro-laico/core/cache

Components

Export

Type

Toastercomponent

The frontend toast / notification component. Mount it once in your root layout so server actions can surface toasts.

Example

import { Toaster } from '@pro-laico/core/components/frontend/Toaster'// app/(frontend)/layout.tsxexport default function RootLayout({ children }) {return (  <html>    <body>      {children}      <Toaster />    </body>  </html>)}

Location

@pro-laico/core/components/frontend/Toaster

LivePreviewListenercomponent

A frontend component that refreshes the page during Payload live preview. Render it inside draft mode so admin edits reflect live.

Example

import { draftMode } from 'next/headers'import { LivePreviewListener } from '@pro-laico/core/components/frontend/LivePreviewListener'// app/(frontend)/layout.tsxexport default async function RootLayout({ children }) {const { isEnabled: draft } = await draftMode()return (  <html>    <body>      {draft && <LivePreviewListener />}      {children}    </body>  </html>)}

Location

@pro-laico/core/components/frontend/LivePreviewListener

SlugComponentcomponent

The slug field admin UI (the default export, a client component). It renders the slug text input with a Lock / Unlock button that toggles the paired slugLock checkbox; while locked, the input is read-only and the slug stays auto-formatted from the watched field (the fieldToUse you gave slugField). slugField wires it in for you by pointing the field's admin component path at this subpath (the SlugPath constant) with the matching clientProps, so you rarely import it yourself.

Location

@pro-laico/core/ui/fields/slug

siteTriggers componentcomponent

The admin component for the deploy / site triggers (referenced via SiteTriggersPath).

Location

@pro-laico/core/ui/root/siteTriggers

APF admin componentscomponent

The APF controls, field, and label admin components (also at /admin/field and /admin/label, referenced via the APF path constants).

Location

@pro-laico/core/admin/controls

path constantsconstant

String paths Payload's importMap resolves to admin components: APFControlsPath, APFieldPath, APFieldLabelPath, SiteTriggersPath, and SlugPath.

Location

@pro-laico/core

Kernel & config

Export

Type

kernel typestype

The type-indirection layer: the PayloadAugment interface, the Get<> lookup, the default fallbacks, and generic config helpers like CollectionBySlug.

Location

@pro-laico/core

registerPayloadConfigfunction

Registers your Payload config so the cache helpers and getPayloadInstance can reach the Local API without importing @payload-config from package source. Call it once at startup, in your Next.js instrumentation hook.

Parameters

config:PayloadConfigPromiseYour project config (or its resolution promise), typically import configPromise from '@payload-config'.

Returns

voidStores the config on a process-global registry.

Example

// src/instrumentation.tsexport async function register(): Promise<void> {if (process.env.NEXT_RUNTIME !== 'nodejs') returnconst { registerPayloadConfig } = await import('@pro-laico/core/config')const { default: configPromise } = await import('@payload-config')registerPayloadConfig(configPromise)}

Location

@pro-laico/core/config

getPayloadInstancefunction

Returns a memoized Local API Payload instance, resolved from the config registered via registerPayloadConfig. Use it in cache getters and server code instead of importing @payload-config directly. Takes no arguments.

Returns

Promise<Payload>The host project's Payload instance.

Example

import { getPayloadInstance } from '@pro-laico/core/payload'const payload = await getPayloadInstance()const { docs } = await payload.find({ collection: 'pages' })

Location

@pro-laico/core/payload

createPreviewRouteHandlerfunction

Factory for the Next.js GET handler that enables Payload draft mode after validating the previewSecret query param. Mount it at the route generateLivePreviewPath points to.

Parameters

args:{ configPromise }The host Payload config (or its promise), typically import configPromise from '@payload-config'.

Returns

(req: NextRequest) => Promise<Response>The route handler. Export it as GET.

Example

// app/(frontend)/next/preview/route.tsimport configPromise from '@payload-config'import { createPreviewRouteHandler } from '@pro-laico/core/next/preview'export const GET = createPreviewRouteHandler({ configPromise })

Location

@pro-laico/core/next/preview

exitPreviewRouteHandlerfunction

The Next.js GET handler that disables Payload draft mode. Mount it alongside the preview route. It is the handler itself, not a factory.

Returns

Promise<Response>Disables draft mode and returns a confirmation response.

Example

// app/(frontend)/next/exit-preview/route.tsimport { exitPreviewRouteHandler } from '@pro-laico/core/next/exit-preview'export const GET = exitPreviewRouteHandler

Location

@pro-laico/core/next/exit-preview

@pro-laico/core

Installation

Setup

Revalidate caches with `revalidationPlugin`

Generate accurate block types with `jsonSchemaPlugin`

Generate types with the augmentation step

Options

`revalidationPlugin(options?)`

`jsonSchemaPlugin(options)`

Environment variables

Caching & revalidation

Exports

Plugins & composition

Fields

Hooks

URL & metadata helpers

Utilities

Cache

Components

Kernel & config

Architecture & the plugin model

The kernel: Get and PayloadAugment

Type augmentation

Caching & revalidation

@pro-laico/zap

On this page

@pro-laico/core

Advanced: block lists

Architecture & the plugin model

The kernel: Get and PayloadAugment

Type augmentation

Caching & revalidation

@pro-laico/zap

On this page