@orion-studios/payload-studio

payload-studio is the base package for Orion's XO-style websites. It defines the supported contract for:

• Payload admin customization
• Studio builder primitives
• block schema and document compilation
• Next.js query helpers
• shared media and social/global helpers

Canonical Guide

Start here for any new project:

• Studio Website Setup Guide

Stable Import Pattern

Prefer explicit subpath imports.

import { configureAdmin, type StudioSection } from '@orion-studios/payload-studio/admin'
import { createPayloadClient, createPageQueries, createSiteQueries } from '@orion-studios/payload-studio/nextjs'
import { defaultPageLayoutBlocks } from '@orion-studios/payload-studio/blocks'
import { createStudioPagesCollection, pageStudioModuleManifest } from '@orion-studios/payload-studio/studio-pages'
import { withImageUploadOptimization } from '@orion-studios/payload-studio/studio'
import { validateEmail, formatPhoneUS } from '@orion-studios/payload-studio/forms'
import { createFormSubmissionHandler } from '@orion-studios/payload-studio/forms/server'

The root @orion-studios/payload-studio namespace export remains available for backward compatibility, but new integrations should treat subpath imports as the public contract.

Quick Start

npm install @orion-studios/payload-studio
npx payload-studio-init   # scaffolds app scripts, lib wrappers, and the form submission route

import { configureAdmin } from '@orion-studios/payload-studio/admin'

const adminConfig = configureAdmin({
  brandName: 'Client Name',
  brandPrimary: '#243654',
  brandSecondary: '#b56f4d',
  defaultTheme: 'brand-light',
  logoUrl: '/branding/logo.svg',
  studio: {
    forms: {
      enabled: true,
      collectionSlug: 'forms',
      submissionsCollectionSlug: 'form-submissions',
      uploadsCollectionSlug: 'form-uploads',
    },
    globals: [
      { slug: 'site-settings', label: 'Website Settings' },
      { slug: 'header', label: 'Header & Navigation' },
      { slug: 'footer', label: 'Footer' },
      { slug: 'social-media', label: 'Social Media' },
      { slug: 'contact-form', label: 'Contact Form' },
    ],
  },
})

Key Exports

• @orion-studios/payload-studio/admin
• @orion-studios/payload-studio/admin/client
• @orion-studios/payload-studio/admin.css
• @orion-studios/payload-studio/admin-app
• @orion-studios/payload-studio/admin-app/client
• @orion-studios/payload-studio/admin-app/styles.css
• @orion-studios/payload-studio/blocks
• @orion-studios/payload-studio/forms
• @orion-studios/payload-studio/forms/server
• @orion-studios/payload-studio/nextjs
• @orion-studios/payload-studio/studio
• @orion-studios/payload-studio/studio-pages
• @orion-studios/payload-studio/studio-pages/client
• @orion-studios/payload-studio/studio-pages/builder.css

Add-on Integration

StudioSection from @orion-studios/payload-studio/admin is the official contract for optional add-ons such as analytics and SEO.

Build

npm run build
npm run test

License

MIT © Orion Studios