@orion-studios/cms 0.5.0

package/dist/studio/index.d.ts

@@ -0,0 +1,534 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ComponentType, InputHTMLAttributes } from 'react';
+import { z } from 'zod';
+import { SupabaseClient, Session } from '@supabase/supabase-js';
+import { F as FormConfig, a as FormNotifyConfig } from '../submission-CzrfXu17.js';
+
+/**
+ * Editor field derivation: turns a block's Zod schema into a default editor
+ * field list so blocks are editable with zero editor configuration. Explicit
+ * `editor.fields` entries in defineBlock() override the derived ones per key.
+ */
+type EditorInput = 'text' | 'textarea' | 'number' | 'checkbox' | 'select' | 'link' | 'media' | 'file' | 'paragraphs' | 'stringList' | 'itemList';
+type EditorField = {
+    key: string;
+    label: string;
+    input: EditorInput;
+    /** Editable inline in the preview (text/textarea only). */
+    inline?: boolean;
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    /** For itemList: fields of each item, derived recursively. */
+    itemFields?: EditorField[];
+    /** For itemList: a new-item template from the item schema's defaults. */
+    itemTemplate?: Record<string, unknown>;
+    /** For itemList: item property used as the collapsed label. */
+    itemLabelKey?: string;
+};
+
+/**
+ * Globals follow the same single-source-of-truth pattern as blocks: one
+ * `defineGlobal()` call yields the schema, defaults, validation, and the
+ * Studio's editor fields.
+ */
+type GlobalDefinition<TSchema extends z.ZodObject<z.ZodRawShape> = z.ZodObject<z.ZodRawShape>> = {
+    key: string;
+    label: string;
+    description?: string;
+    schema: TSchema;
+    editor: {
+        fields: EditorField[];
+    };
+    defaultData: z.infer<TSchema>;
+};
+type GlobalRegistry = {
+    list(): GlobalDefinition[];
+    get(key: string): GlobalDefinition | undefined;
+    /** Parses stored data through the schema (defaults applied, unknown keys stripped). */
+    normalize(key: string, data: unknown): Record<string, unknown>;
+};
+
+/**
+ * The Orion CMS block system.
+ *
+ * One `defineBlock()` call is the single source of truth for a section type.
+ * Everything else — TypeScript types, default data, server-side validation,
+ * the builder palette, the inspector fields, and rendering — derives from it.
+ */
+/** A block instance as stored inside a page's JSONB layout. */
+type BlockInstance<TData = Record<string, unknown>> = {
+    id: string;
+    type: string;
+    data: TData;
+    /** Presentation settings (spacing, background, visibility) — builder-owned. */
+    settings?: Record<string, unknown>;
+};
+type PageLayout = BlockInstance[];
+type BlockPreviewProps<TData> = {
+    data: TData;
+    /** True when rendering inside the Studio builder (enables inline editing affordances). */
+    editing?: boolean;
+    /** Inline-commit callback available in the builder. */
+    onChange?: (patch: Partial<TData>) => void;
+};
+type BlockDefinition<TSchema extends z.ZodObject<z.ZodRawShape> = z.ZodObject<z.ZodRawShape>> = {
+    type: string;
+    label: string;
+    description?: string;
+    /** Palette grouping in the builder. */
+    category?: string;
+    schema: TSchema;
+    /** Derived from the schema; entries here override per key and set order. */
+    editor: {
+        fields: EditorField[];
+    };
+    defaultData: z.infer<TSchema>;
+    preview?: ComponentType<BlockPreviewProps<z.infer<TSchema>>>;
+};
+type ValidationIssue = {
+    blockId: string;
+    blockType: string;
+    path: string;
+    message: string;
+};
+type BlockRegistry = {
+    list(): BlockDefinition[];
+    get(type: string): BlockDefinition | undefined;
+    has(type: string): boolean;
+    /** Palette entries for the builder's Add Section panel. */
+    palette(): Array<{
+        type: string;
+        label: string;
+        description?: string;
+        category?: string;
+        defaultData: Record<string, unknown>;
+    }>;
+    /**
+     * Validates and normalizes a layout: unknown block types are rejected,
+     * each block's data is parsed through its schema (applying defaults,
+     * stripping unknown keys), and issues are collected per block.
+     */
+    validateLayout(layout: unknown): {
+        ok: boolean;
+        layout: PageLayout;
+        issues: ValidationIssue[];
+    };
+    /** Creates a new block instance of the given type with schema defaults. */
+    createInstance(type: string): BlockInstance;
+};
+
+/**
+ * The Orion Studio: the complete admin experience as one client component.
+ *
+ * Mount it at a route in the consuming app:
+ *
+ *   // src/app/(studio)/studio/page.tsx
+ *   import { SiteStudio } from '@/cms/studio'
+ *   export default function StudioPage() { return <SiteStudio /> }
+ *
+ * where @/cms/studio wires the site's block + global registries and branding.
+ */
+type StudioConfig = {
+    registry: BlockRegistry;
+    globals: GlobalRegistry;
+    siteName: string;
+    logoUrl?: string;
+    /** Supabase project URL used for media transform URLs. Defaults to env. */
+    supabaseUrl?: string;
+};
+declare function Studio({ registry, globals, siteName, logoUrl, supabaseUrl }: StudioConfig): react_jsx_runtime.JSX.Element;
+
+declare function getBrowserSupabase(): SupabaseClient;
+declare function useStudioSession(): {
+    session: Session | null;
+    loading: boolean;
+    getToken: () => Promise<string | null>;
+    signOut: () => Promise<void>;
+};
+
+type PasswordInputProps = Omit<InputHTMLAttributes<HTMLInputElement>, 'type'>;
+declare function PasswordInput({ className, ...props }: PasswordInputProps): react_jsx_runtime.JSX.Element;
+
+type AnalyticsKpis = {
+    visitors: number;
+    identifiedVisitors: number;
+    returningVisitors: number;
+    sessions: number;
+    pageviews: number;
+    pagesPerVisitor: number;
+    calls: number;
+    formSubmits: number;
+    emails: number;
+    portalClicks: number;
+    conversions: number;
+    conversionRate: number;
+};
+type AnalyticsSummary = {
+    range: {
+        from: string;
+        to: string;
+    };
+    kpis: AnalyticsKpis;
+    previous: AnalyticsKpis;
+    trend: Array<{
+        day: string;
+        visitors: number;
+        conversions: number;
+    }>;
+    pages: Array<{
+        path: string;
+        views: number;
+        entries: number;
+        conversions: number;
+    }>;
+    sources: Array<{
+        source: string;
+        sessions: number;
+        conversions: number;
+    }>;
+    locations: Array<{
+        location: string;
+        sessions: number;
+    }>;
+    devices: Array<{
+        device: string;
+        sessions: number;
+    }>;
+    hours: number[];
+    paths: Array<{
+        path: string[];
+        count: number;
+        converted: number;
+    }>;
+    forms: Array<{
+        form: string;
+        views: number;
+        starts: number;
+        submits: number;
+    }>;
+    notFound: Array<{
+        path: string;
+        count: number;
+    }>;
+};
+
+/**
+ * Typed client for /api/cms used by the Studio. Every call attaches the
+ * current Supabase access token as a bearer credential.
+ */
+type StudioPageSummary = {
+    id: string;
+    slug: string;
+    path: string;
+    title: string;
+    status: 'draft' | 'published';
+    builder_owned: boolean;
+    updated_at: string;
+    published_at: string | null;
+    publish_at: string | null;
+    /** Computed by GET /pages: draft layout differs from the live one. */
+    has_draft_changes?: boolean;
+};
+type StudioPage = StudioPageSummary & {
+    seo: Record<string, unknown>;
+    draft_layout: PageLayout;
+    published_layout: PageLayout | null;
+};
+type StudioMedia = {
+    id: string;
+    storage_path: string;
+    filename: string;
+    alt: string;
+    caption: string;
+    mime_type: string;
+    width: number | null;
+    height: number | null;
+};
+type StudioVersion = {
+    id: number;
+    kind: string;
+    title: string;
+    author: string;
+    created_at: string;
+};
+type StudioVersionDetail = StudioVersion & {
+    page_id: string;
+    seo: Record<string, unknown>;
+    layout: PageLayout;
+};
+type StudioRole = 'admin' | 'developer' | 'editor' | 'content';
+type StudioUser = {
+    id: string;
+    email: string | null;
+    name: string;
+    role: StudioRole | null;
+    created_at: string | null;
+    last_sign_in_at: string | null;
+};
+type StudioSubmission = {
+    id: number;
+    form_id: string;
+    data: Record<string, unknown>;
+    source: string;
+    read_at: string | null;
+    created_at: string;
+};
+type StudioForm = {
+    id: string;
+    slug: string;
+    title: string;
+    config: FormConfig;
+    /** Stored separately from config so the public read layer never sees it. */
+    notify?: FormNotifyConfig;
+    success_message: string;
+    updated_at: string;
+    submissionCount?: number;
+    unreadCount?: number;
+};
+type StudioRedirect = {
+    id: string;
+    from_path: string;
+    to_path: string;
+    permanent: boolean;
+    created_at: string;
+};
+type StudioActivity = {
+    id: number;
+    actor_name: string;
+    action: string;
+    subject: string;
+    created_at: string;
+};
+type StudioDashboard = {
+    pages: {
+        total: number;
+        pendingDrafts: Array<{
+            id: string;
+            title: string;
+            path: string;
+            status: string;
+            publish_at: string | null;
+        }>;
+        recent: StudioPageSummary[];
+        lastPublishedAt: string | null;
+    };
+    submissions: {
+        total: number;
+        unread: number;
+        recent: StudioSubmission[];
+    };
+    activity: StudioActivity[];
+};
+type StudioMediaUsage = Array<{
+    id: string;
+    title: string;
+    path: string;
+}>;
+declare class StudioApiError extends Error {
+    status: number;
+    fieldErrors?: Record<string, string>;
+    issues?: unknown[];
+    usage?: StudioMediaUsage;
+    constructor(status: number, message: string, extra?: {
+        fieldErrors?: Record<string, string>;
+        issues?: unknown[];
+        usage?: StudioMediaUsage;
+    });
+}
+type StudioApi = ReturnType<typeof createStudioApi>;
+declare function createStudioApi(options: {
+    getToken: () => Promise<string | null>;
+    basePath?: string;
+}): {
+    me: () => Promise<{
+        user: {
+            id: string;
+            email: string | null;
+            role: StudioRole;
+            name: string;
+        };
+    }>;
+    listPages: () => Promise<{
+        pages: StudioPageSummary[];
+    }>;
+    getPage: (id: string) => Promise<{
+        page: StudioPage;
+    }>;
+    createPage: (input: {
+        slug: string;
+        title: string;
+        path?: string;
+    }) => Promise<{
+        page: StudioPage;
+    }>;
+    saveDraft: (id: string, input: {
+        title?: string;
+        seo?: Record<string, unknown>;
+        layout?: PageLayout;
+        slug?: string;
+        path?: string;
+        publishAt?: string | null;
+    }) => Promise<{
+        page: StudioPage;
+    }>;
+    publish: (id: string) => Promise<{
+        page: StudioPage;
+    }>;
+    unpublish: (id: string) => Promise<{
+        page: StudioPage;
+    }>;
+    duplicatePage: (id: string) => Promise<{
+        page: StudioPage;
+    }>;
+    deletePage: (id: string) => Promise<{
+        success: true;
+    }>;
+    previewToken: (id: string) => Promise<{
+        token: string;
+        path: string;
+        url: string;
+    }>;
+    listVersions: (id: string) => Promise<{
+        versions: StudioVersion[];
+    }>;
+    getVersion: (versionId: number) => Promise<{
+        version: StudioVersionDetail;
+    }>;
+    restoreVersion: (versionId: number) => Promise<{
+        page: StudioPage;
+    }>;
+    getGlobal: (key: string) => Promise<{
+        global: {
+            key: string;
+            data: Record<string, unknown>;
+        };
+    }>;
+    updateGlobal: (key: string, data: Record<string, unknown>) => Promise<{
+        global: {
+            key: string;
+            data: Record<string, unknown>;
+        };
+    }>;
+    listGlobalVersions: (key: string) => Promise<{
+        versions: Array<{
+            id: number;
+            key: string;
+            data: Record<string, unknown>;
+            created_at: string;
+        }>;
+    }>;
+    restoreGlobalVersion: (versionId: number) => Promise<{
+        global: {
+            key: string;
+            data: Record<string, unknown>;
+        };
+    }>;
+    listMedia: () => Promise<{
+        media: StudioMedia[];
+    }>;
+    uploadMedia: (form: FormData) => Promise<{
+        media: StudioMedia;
+    }>;
+    updateMedia: (id: string, input: {
+        alt?: string;
+        caption?: string;
+        filename?: string;
+    }) => Promise<{
+        media: StudioMedia;
+    }>;
+    replaceMedia: (id: string, form: FormData) => Promise<{
+        media: StudioMedia;
+    }>;
+    mediaUsage: (id: string) => Promise<{
+        usage: StudioMediaUsage;
+    }>;
+    deleteMedia: (id: string, force?: boolean) => Promise<{
+        success: true;
+    }>;
+    listForms: () => Promise<{
+        forms: StudioForm[];
+    }>;
+    createForm: (input: {
+        slug: string;
+        title: string;
+    }) => Promise<{
+        form: StudioForm;
+    }>;
+    getForm: (slug: string) => Promise<{
+        form: StudioForm;
+    }>;
+    updateForm: (slug: string, input: {
+        title: string;
+        config: FormConfig;
+        notify?: FormNotifyConfig;
+        successMessage: string;
+    }) => Promise<{
+        form: StudioForm;
+    }>;
+    deleteForm: (slug: string) => Promise<{
+        success: true;
+    }>;
+    listSubmissions: (params?: {
+        form?: string;
+        beforeId?: number;
+        unread?: boolean;
+        limit?: number;
+    }) => Promise<{
+        submissions: StudioSubmission[];
+        hasMore: boolean;
+    }>;
+    markSubmission: (id: number, read: boolean) => Promise<{
+        success: true;
+    }>;
+    deleteSubmission: (id: number) => Promise<{
+        success: true;
+    }>;
+    exportSubmissionsCsv: (form?: string) => Promise<string>;
+    listRedirects: () => Promise<{
+        redirects: StudioRedirect[];
+    }>;
+    createRedirect: (input: {
+        fromPath: string;
+        toPath: string;
+        permanent?: boolean;
+    }) => Promise<{
+        redirect: StudioRedirect;
+    }>;
+    deleteRedirect: (id: string) => Promise<{
+        success: true;
+    }>;
+    dashboard: () => Promise<StudioDashboard>;
+    listActivity: () => Promise<{
+        activity: StudioActivity[];
+    }>;
+    analytics: (params?: {
+        from?: string;
+        to?: string;
+    }) => Promise<AnalyticsSummary>;
+    listUsers: () => Promise<{
+        users: StudioUser[];
+        assignableRoles: StudioRole[];
+    }>;
+    createUser: (input: {
+        email: string;
+        password: string;
+        role: StudioRole;
+        name?: string;
+    }) => Promise<{
+        user: StudioUser;
+    }>;
+    updateUser: (id: string, input: {
+        role?: StudioRole;
+        name?: string;
+        password?: string;
+    }) => Promise<{
+        success: true;
+    }>;
+    deleteUser: (id: string) => Promise<{
+        success: true;
+    }>;
+};
+
+export { PasswordInput, type PasswordInputProps, Studio, type StudioActivity, type StudioApi, StudioApiError, type StudioConfig, type StudioDashboard, type StudioForm, type StudioMedia, type StudioMediaUsage, type StudioPage, type StudioPageSummary, type StudioRedirect, type StudioSubmission, type StudioVersion, type StudioVersionDetail, createStudioApi, getBrowserSupabase, useStudioSession };