Examples

A localized article collection

import {
  jalaliDateField,
  moneyField,
  slugField,
  withJalaliTimestamps,
} from "@nexload-sdk/payload-fields";
import type { CollectionConfig } from "payload";

export const Articles: CollectionConfig = {
  slug: "articles",
  fields: withJalaliTimestamps([
    { name: "title", type: "text", required: true, localized: true },
    ...slugField({
      source: "title",
      overrides: {
        slug: { localized: true, unique: true },
        lock: { localized: true },
      },
    }),
    jalaliDateField({ name: "publishedAt", pickerAppearance: "dayAndTime" }),
    moneyField({ name: "sponsorFee", currency: "IRR", allowNegative: false }),
  ]),
};

Parse at an import boundary

import {
  formatSlug,
  parseMoneyToMinorUnits,
} from "@nexload-sdk/payload-fields";

const data = {
  slug: formatSlug(row.title),
  price: parseMoneyToMinorUnits(row.displayPrice, "IRT"),
};

await payload.create({ collection: "products", data });

The Local API receives the stored representation, not Admin display text.

Restricted generator

payloadFieldsPlugin({
  generateSlugAccess: ({ req }) =>
    Boolean(req.user && req.user.roles?.includes("editor")),
  slugGenerators: {
    catalog: async ({ sourceValue, currentSlug }, { req }) => {
      const suffix = currentSlug ? "" : `-${req.locale ?? "fa"}`;
      return `${sourceValue}${suffix}`;
    },
  },
})

Do not place secrets in generator results or thrown errors. The public endpoint deliberately returns safe, localized errors.

The core field composition example is type-checked in CI: payload-fields.ts.