@orion-studios/payload-studio 0.5.0-beta.99 → 0.6.0-beta.10

package/README.md

@@ -1,102 +1,92 @@
 # @orion-studios/payload-studio
 
-Unified Payload CMS toolkit for Orion Studios projects.
+`payload-studio` is the base package for Orion's XO-style websites. It defines the supported contract for:
 
-## Install
+- Payload admin customization
+- Studio builder primitives
+- block schema and document compilation
+- Next.js query helpers
+- shared media and social/global helpers
 
-```bash
-npm install @orion-studios/payload-studio
-```
+## Canonical Guide
 
-## Subpath Exports
+Start here for any new project:
 
-- `@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/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`
+- [Studio Website Setup Guide](./docs/studio-website-setup-guide.md)
 
-## Quick Usage
+## Stable Import Pattern
+
+Prefer explicit subpath imports.
 
 ```ts
-import { configureAdmin } from '@orion-studios/payload-studio/admin'
+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 { createPayloadClient, createPageQueries } from '@orion-studios/payload-studio/nextjs'
-import { createStudioRegistry } from '@orion-studios/payload-studio/studio'
 import { pageStudioModuleManifest } from '@orion-studios/payload-studio/studio-pages'
-```
-
-```ts
 import { withImageUploadOptimization } from '@orion-studios/payload-studio/studio'
-
-// In your Media collection:
-// export const Media = withImageUploadOptimization({
-//   slug: 'media',
-//   upload: { ... },
-//   fields: [...],
-// })
 ```
 
-```ts
-import { BuilderPageEditor } from '@orion-studios/payload-studio/studio-pages/client'
-import '@orion-studios/payload-studio/studio-pages/builder.css'
-```
+The root `@orion-studios/payload-studio` namespace export remains available for backward compatibility, but new integrations should treat subpath imports as the public contract.
 
-```ts
-import { AdminPage } from '@orion-studios/payload-studio/admin-app'
-import { AdminShellClient } from '@orion-studios/payload-studio/admin-app/client'
-import '@orion-studios/payload-studio/admin-app/styles.css'
-```
+## Quick Start
 
-## Social Media Global
+```bash
+npm install @orion-studios/payload-studio
+```
 
 ```ts
-import { createSocialMediaGlobal } from '@orion-studios/payload-studio/admin'
+import { configureAdmin } from '@orion-studios/payload-studio/admin'
 
-export const globals = [
-  createSocialMediaGlobal(),
-]
+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' },
+    ],
+  },
+})
 ```
 
-`createSocialMediaGlobal` creates a `social-media` global with:
-
-- Major platforms (Facebook, Instagram, X, LinkedIn, YouTube, TikTok, Pinterest, Snapchat)
-- URL field for each platform
-- Four icon choices per platform (`Simple Icons`, `Font Awesome Brands`, `Tabler Brands`, `Remix Icons`)
+## Key Exports
 
-You can fetch and normalize these links in Next.js:
+- `@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/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`
 
-```ts
-import { createSiteQueries, resolveSocialMediaLinks } from '@orion-studios/payload-studio/nextjs'
+## Add-on Integration
 
-const { getSocialMedia } = createSiteQueries(getPayloadClient)
-const social = await getSocialMedia()
-const links = resolveSocialMediaLinks(social)
-```
+`StudioSection` from `@orion-studios/payload-studio/admin` is the official contract for optional add-ons such as analytics and SEO.
 
 ## Build
 
 ```bash
-npm install
 npm run build
+npm run test
 ```
 
-## Upload Optimization Hook
-
-`withImageUploadOptimization` and `createImageUploadOptimizationHook` compress raster uploads
-before Payload writes files and before cloud storage adapters upload them.
-
-- Preserves pixel dimensions (no resize)
-- Optimizes JPEG / PNG / WebP / AVIF / TIFF
-- Runs in a collection `beforeOperation` hook
-
 ## License
 
 MIT © Orion Studios

package/dist/admin/client.d.mts

@@ -9,6 +9,8 @@ export declare function useTheme(): {
 
 export declare const Logo: FC<any>
 export declare const Icon: FC<any>
+export declare const AdminLoginIntro: FC<any>
+export declare const AdminLoginPasswordToggle: FC<any>
 export declare const Dashboard: FC<any>
 export declare const ThemeSwitcher: FC<any>
 export declare const ThemeProvider: FC<any>
@@ -19,15 +21,19 @@ export declare const BlockPicker: FC<any>
 export declare const SectionTabs: FC<any>
 export declare const OrionBlocksField: FC<any>
 export declare const WelcomeHeader: FC<any>
-export declare const AdminStudioDashboard: FC<any>
 export declare const AdminStudioNav: FC<any>
+export declare const StudioSectionLayout: FC<any>
+export declare const AdminStudioDashboard: FC<any>
 export declare const AdminStudioPagesListView: FC<any>
 export declare const AdminStudioPageEditView: FC<any>
 export declare const AdminStudioGlobalsView: FC<any>
 export declare const AdminStudioContactFormView: FC<any>
 export declare const AdminStudioMediaView: FC<any>
+export declare const AdminStudioFormsView: FC<any>
 export declare const AdminStudioToolsView: FC<any>
 export declare const OpenInStudioMenuItem: FC<any>
 export declare const PageEditRedirectToStudio: FC<any>
 export declare const StudioBackBreadcrumb: FC<any>
 export declare const StudioContactFormRedirect: FC<any>
+export declare function resolveAdminPath(adminBasePath: string, targetPath: string): string
+export declare function useAdminBasePath(fallback?: string): string

package/dist/admin/client.d.ts

@@ -9,6 +9,8 @@ export declare function useTheme(): {
 
 export declare const Logo: FC<any>
 export declare const Icon: FC<any>
+export declare const AdminLoginIntro: FC<any>
+export declare const AdminLoginPasswordToggle: FC<any>
 export declare const Dashboard: FC<any>
 export declare const ThemeSwitcher: FC<any>
 export declare const ThemeProvider: FC<any>
@@ -19,15 +21,19 @@ export declare const BlockPicker: FC<any>
 export declare const SectionTabs: FC<any>
 export declare const OrionBlocksField: FC<any>
 export declare const WelcomeHeader: FC<any>
-export declare const AdminStudioDashboard: FC<any>
 export declare const AdminStudioNav: FC<any>
+export declare const StudioSectionLayout: FC<any>
+export declare const AdminStudioDashboard: FC<any>
 export declare const AdminStudioPagesListView: FC<any>
 export declare const AdminStudioPageEditView: FC<any>
 export declare const AdminStudioGlobalsView: FC<any>
 export declare const AdminStudioContactFormView: FC<any>
 export declare const AdminStudioMediaView: FC<any>
+export declare const AdminStudioFormsView: FC<any>
 export declare const AdminStudioToolsView: FC<any>
 export declare const OpenInStudioMenuItem: FC<any>
 export declare const PageEditRedirectToStudio: FC<any>
 export declare const StudioBackBreadcrumb: FC<any>
 export declare const StudioContactFormRedirect: FC<any>
+export declare function resolveAdminPath(adminBasePath: string, targetPath: string): string
+export declare function useAdminBasePath(fallback?: string): string