@orion-studios/payload-studio 0.6.0-beta.7 → 0.6.0-beta.70

package/dist/builder-v2/index.d.mts

@@ -0,0 +1,237 @@
+import { Field, Payload } from 'payload';
+import { ComponentType, ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+type BuilderV2FieldOptions = {
+    hidden?: boolean;
+};
+declare const createBuilderV2PageFields: (options?: BuilderV2FieldOptions) => Field[];
+declare const appendBuilderV2PageFields: (fields: Field[], options?: BuilderV2FieldOptions) => Field[];
+
+type BuilderV2Mode = 'grapes-v2';
+type BuilderV2ValidationIssue = {
+    code: string;
+    message: string;
+    path: string;
+    severity: 'error' | 'warning';
+};
+type BuilderV2Role = 'admin' | 'client' | 'developer' | 'editor';
+type BuilderV2PermissionSet = {
+    canEditCustomCode?: boolean;
+    canManageGlobalStyles?: boolean;
+    canManageReusableSections?: boolean;
+    canPublish?: boolean;
+    canUseEmbeds?: boolean;
+    role?: BuilderV2Role;
+};
+type BuilderV2CompiledOutput = {
+    css: string;
+    dynamicComponents: BuilderV2DynamicComponentInstance[];
+    html: string;
+    validationIssues?: BuilderV2ValidationIssue[];
+};
+type BuilderV2ProjectData = Record<string, unknown>;
+type BuilderV2ThemeTokens = {
+    buttons?: Record<string, unknown>;
+    colors?: Record<string, string>;
+    fonts?: Record<string, string>;
+    radii?: Record<string, string>;
+    shadows?: Record<string, string>;
+    spacing?: Record<string, string>;
+    typography?: Record<string, unknown>;
+};
+type BuilderV2PageTreeNode = {
+    children?: BuilderV2PageTreeNode[];
+    id: number | string;
+    parentId?: number | string | null;
+    path: string;
+    slug: string;
+    status?: 'draft' | 'published';
+    title: string;
+};
+type BuilderV2VersionSnapshot = {
+    compiledCss?: string;
+    compiledHtml?: string;
+    createdAt: string;
+    id: string;
+    label: string;
+    projectData?: BuilderV2ProjectData | null;
+    published?: boolean;
+};
+type BuilderV2ReusableSection = {
+    category?: string;
+    id: string;
+    name: string;
+    projectData: BuilderV2ProjectData;
+    thumbnail?: string;
+};
+type BuilderV2EditorMeta = {
+    editorPageBasePath?: string;
+    pageTree?: BuilderV2PageTreeNode[];
+    permissions?: BuilderV2PermissionSet;
+    themeTokens?: BuilderV2ThemeTokens;
+};
+type BuilderV2PageData = {
+    builderAutosaveProjectData?: BuilderV2ProjectData | null;
+    builderDynamicComponents?: BuilderV2DynamicComponentInstance[];
+    builderLastPublishedAt?: string;
+    builderLastSavedAt?: string;
+    builderLockedAreas?: string[];
+    builderMode?: string;
+    builderProjectData?: BuilderV2ProjectData | null;
+    builderPublishedProjectData?: BuilderV2ProjectData | null;
+    builderPublishedSnapshot?: BuilderV2VersionSnapshot | null;
+    builderReusableSections?: BuilderV2ReusableSection[];
+    builderSeo?: Record<string, unknown> | null;
+    builderThemeTokens?: BuilderV2ThemeTokens | null;
+    builderValidationIssues?: BuilderV2ValidationIssue[];
+    builderVersions?: BuilderV2VersionSnapshot[];
+    compiledCss?: string;
+    compiledHtml?: string;
+    id?: number | string;
+    slug?: string;
+    title?: string;
+};
+type BuilderV2Asset = {
+    alt?: string;
+    filename?: string;
+    id: number | string;
+    src: string;
+    type?: string;
+};
+type BuilderV2DynamicComponentInstance = {
+    component: string;
+    id: string;
+    props: Record<string, unknown>;
+};
+type BuilderV2RuntimeComponentProps = {
+    instance: BuilderV2DynamicComponentInstance;
+    page?: BuilderV2PageData;
+};
+type BuilderV2RuntimeComponent = ComponentType<BuilderV2RuntimeComponentProps>;
+type BuilderV2ProjectComponentDefinition = {
+    editorPreview?: (props: Record<string, unknown>) => string;
+    label: string;
+    render: BuilderV2RuntimeComponent;
+    traits?: BuilderV2TraitDefinition[];
+    type: string;
+};
+type BuilderV2TraitDefinition = {
+    label: string;
+    name: string;
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    placeholder?: string;
+    type: 'checkbox' | 'number' | 'select' | 'text' | 'textarea';
+};
+type BuilderV2ProjectAdapter = {
+    components?: Record<string, BuilderV2ProjectComponentDefinition | BuilderV2RuntimeComponent>;
+    dataProviders?: Record<string, unknown>;
+    defaultThemeTokens?: BuilderV2ThemeTokens;
+    id: string;
+    label?: string;
+    themeTokens?: Record<string, unknown>;
+};
+type BuilderV2EditorInitialData = {
+    meta?: BuilderV2EditorMeta;
+    projectData?: BuilderV2ProjectData | null;
+    title?: string;
+};
+type BuilderV2RuntimeProps = {
+    adapter?: BuilderV2ProjectAdapter;
+    className?: string;
+    page: BuilderV2PageData;
+};
+type BuilderV2RenderableChunk = {
+    html: string;
+    kind: 'html';
+} | {
+    instance: BuilderV2DynamicComponentInstance;
+    kind: 'component';
+};
+type BuilderV2RenderResult = {
+    css: string;
+    nodes: ReactNode;
+};
+
+declare const compileBuilderV2Output: (input: {
+    css?: unknown;
+    html?: unknown;
+}) => BuilderV2CompiledOutput;
+
+type BuilderV2PagePayloadDoc = BuilderV2PageData & {
+    id: number | string;
+};
+type CreateBuilderV2PageServiceArgs = {
+    collectionSlug?: string;
+    payload: Payload;
+    user: Record<string, unknown>;
+};
+type SaveBuilderV2PageInput = {
+    compiled: {
+        css?: string;
+        html?: string;
+    };
+    projectData: BuilderV2ProjectData;
+    title?: string;
+    validationIssues?: BuilderV2ValidationIssue[];
+};
+declare const toBuilderV2EditorInitialData: (page: BuilderV2PageData) => {
+    projectData: BuilderV2ProjectData;
+    title: string;
+};
+declare const createBuilderV2PageService: ({ collectionSlug, payload, user, }: CreateBuilderV2PageServiceArgs) => {
+    getPageForBuilder: (pageID: string) => Promise<{
+        id: string;
+        initialData: {
+            projectData: BuilderV2ProjectData;
+            title: string;
+        };
+        page: BuilderV2PagePayloadDoc;
+    }>;
+    saveDraft: (pageID: string, input: SaveBuilderV2PageInput) => Promise<{
+        compiled: BuilderV2CompiledOutput;
+        id: string;
+        status: "draft";
+    }>;
+    publish: (pageID: string, input: SaveBuilderV2PageInput) => Promise<{
+        compiled: BuilderV2CompiledOutput;
+        id: string;
+        status: "published";
+    }>;
+};
+
+declare const createEmptyBuilderV2ProjectData: (title?: string) => BuilderV2ProjectData;
+declare const normalizeBuilderV2ProjectData: (value: unknown, fallbackTitle?: string) => BuilderV2ProjectData;
+
+type PageLike = {
+    id: number | string;
+    parent?: number | string | {
+        id?: number | string;
+    } | null;
+    parentId?: number | string | null;
+    path?: string | null;
+    slug?: string | null;
+    title?: string | null;
+    _status?: 'draft' | 'published';
+};
+declare const buildBuilderV2PageTree: (pages: PageLike[]) => BuilderV2PageTreeNode[];
+
+declare function BuilderPageRuntime({ adapter, className, page }: BuilderV2RuntimeProps): react_jsx_runtime.JSX.Element;
+
+declare const parseBuilderV2DynamicComponents: (html: string) => BuilderV2DynamicComponentInstance[];
+declare const splitBuilderV2HtmlIntoChunks: (html: string) => BuilderV2RenderableChunk[];
+
+declare const sanitizeBuilderHtml: (value: unknown) => string;
+declare const sanitizeBuilderCss: (value: unknown) => string;
+declare const scopeBuilderCss: (value: unknown, scope?: string) => string;
+
+declare const validateBuilderV2Output: (input: {
+    css?: unknown;
+    html?: unknown;
+}) => BuilderV2ValidationIssue[];
+declare const hasBlockingBuilderV2Issues: (issues: BuilderV2ValidationIssue[]) => boolean;
+
+export { BuilderPageRuntime, type BuilderV2Asset, type BuilderV2CompiledOutput, type BuilderV2DynamicComponentInstance, type BuilderV2EditorInitialData, type BuilderV2FieldOptions, type BuilderV2Mode, type BuilderV2PageData, type BuilderV2PagePayloadDoc, type BuilderV2PageTreeNode, type BuilderV2PermissionSet, type BuilderV2ProjectAdapter, type BuilderV2ProjectComponentDefinition, type BuilderV2ProjectData, type BuilderV2RenderResult, type BuilderV2RenderableChunk, type BuilderV2RuntimeComponent, type BuilderV2RuntimeComponentProps, type BuilderV2RuntimeProps, type BuilderV2ThemeTokens, type BuilderV2TraitDefinition, type BuilderV2ValidationIssue, type BuilderV2VersionSnapshot, type CreateBuilderV2PageServiceArgs, type SaveBuilderV2PageInput, appendBuilderV2PageFields, buildBuilderV2PageTree, compileBuilderV2Output, createBuilderV2PageFields, createBuilderV2PageService, createEmptyBuilderV2ProjectData, hasBlockingBuilderV2Issues, normalizeBuilderV2ProjectData, parseBuilderV2DynamicComponents, sanitizeBuilderCss, sanitizeBuilderHtml, scopeBuilderCss, splitBuilderV2HtmlIntoChunks, toBuilderV2EditorInitialData, validateBuilderV2Output };

package/dist/builder-v2/index.d.ts

@@ -0,0 +1,237 @@
+import { Field, Payload } from 'payload';
+import { ComponentType, ReactNode } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+type BuilderV2FieldOptions = {
+    hidden?: boolean;
+};
+declare const createBuilderV2PageFields: (options?: BuilderV2FieldOptions) => Field[];
+declare const appendBuilderV2PageFields: (fields: Field[], options?: BuilderV2FieldOptions) => Field[];
+
+type BuilderV2Mode = 'grapes-v2';
+type BuilderV2ValidationIssue = {
+    code: string;
+    message: string;
+    path: string;
+    severity: 'error' | 'warning';
+};
+type BuilderV2Role = 'admin' | 'client' | 'developer' | 'editor';
+type BuilderV2PermissionSet = {
+    canEditCustomCode?: boolean;
+    canManageGlobalStyles?: boolean;
+    canManageReusableSections?: boolean;
+    canPublish?: boolean;
+    canUseEmbeds?: boolean;
+    role?: BuilderV2Role;
+};
+type BuilderV2CompiledOutput = {
+    css: string;
+    dynamicComponents: BuilderV2DynamicComponentInstance[];
+    html: string;
+    validationIssues?: BuilderV2ValidationIssue[];
+};
+type BuilderV2ProjectData = Record<string, unknown>;
+type BuilderV2ThemeTokens = {
+    buttons?: Record<string, unknown>;
+    colors?: Record<string, string>;
+    fonts?: Record<string, string>;
+    radii?: Record<string, string>;
+    shadows?: Record<string, string>;
+    spacing?: Record<string, string>;
+    typography?: Record<string, unknown>;
+};
+type BuilderV2PageTreeNode = {
+    children?: BuilderV2PageTreeNode[];
+    id: number | string;
+    parentId?: number | string | null;
+    path: string;
+    slug: string;
+    status?: 'draft' | 'published';
+    title: string;
+};
+type BuilderV2VersionSnapshot = {
+    compiledCss?: string;
+    compiledHtml?: string;
+    createdAt: string;
+    id: string;
+    label: string;
+    projectData?: BuilderV2ProjectData | null;
+    published?: boolean;
+};
+type BuilderV2ReusableSection = {
+    category?: string;
+    id: string;
+    name: string;
+    projectData: BuilderV2ProjectData;
+    thumbnail?: string;
+};
+type BuilderV2EditorMeta = {
+    editorPageBasePath?: string;
+    pageTree?: BuilderV2PageTreeNode[];
+    permissions?: BuilderV2PermissionSet;
+    themeTokens?: BuilderV2ThemeTokens;
+};
+type BuilderV2PageData = {
+    builderAutosaveProjectData?: BuilderV2ProjectData | null;
+    builderDynamicComponents?: BuilderV2DynamicComponentInstance[];
+    builderLastPublishedAt?: string;
+    builderLastSavedAt?: string;
+    builderLockedAreas?: string[];
+    builderMode?: string;
+    builderProjectData?: BuilderV2ProjectData | null;
+    builderPublishedProjectData?: BuilderV2ProjectData | null;
+    builderPublishedSnapshot?: BuilderV2VersionSnapshot | null;
+    builderReusableSections?: BuilderV2ReusableSection[];
+    builderSeo?: Record<string, unknown> | null;
+    builderThemeTokens?: BuilderV2ThemeTokens | null;
+    builderValidationIssues?: BuilderV2ValidationIssue[];
+    builderVersions?: BuilderV2VersionSnapshot[];
+    compiledCss?: string;
+    compiledHtml?: string;
+    id?: number | string;
+    slug?: string;
+    title?: string;
+};
+type BuilderV2Asset = {
+    alt?: string;
+    filename?: string;
+    id: number | string;
+    src: string;
+    type?: string;
+};
+type BuilderV2DynamicComponentInstance = {
+    component: string;
+    id: string;
+    props: Record<string, unknown>;
+};
+type BuilderV2RuntimeComponentProps = {
+    instance: BuilderV2DynamicComponentInstance;
+    page?: BuilderV2PageData;
+};
+type BuilderV2RuntimeComponent = ComponentType<BuilderV2RuntimeComponentProps>;
+type BuilderV2ProjectComponentDefinition = {
+    editorPreview?: (props: Record<string, unknown>) => string;
+    label: string;
+    render: BuilderV2RuntimeComponent;
+    traits?: BuilderV2TraitDefinition[];
+    type: string;
+};
+type BuilderV2TraitDefinition = {
+    label: string;
+    name: string;
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    placeholder?: string;
+    type: 'checkbox' | 'number' | 'select' | 'text' | 'textarea';
+};
+type BuilderV2ProjectAdapter = {
+    components?: Record<string, BuilderV2ProjectComponentDefinition | BuilderV2RuntimeComponent>;
+    dataProviders?: Record<string, unknown>;
+    defaultThemeTokens?: BuilderV2ThemeTokens;
+    id: string;
+    label?: string;
+    themeTokens?: Record<string, unknown>;
+};
+type BuilderV2EditorInitialData = {
+    meta?: BuilderV2EditorMeta;
+    projectData?: BuilderV2ProjectData | null;
+    title?: string;
+};
+type BuilderV2RuntimeProps = {
+    adapter?: BuilderV2ProjectAdapter;
+    className?: string;
+    page: BuilderV2PageData;
+};
+type BuilderV2RenderableChunk = {
+    html: string;
+    kind: 'html';
+} | {
+    instance: BuilderV2DynamicComponentInstance;
+    kind: 'component';
+};
+type BuilderV2RenderResult = {
+    css: string;
+    nodes: ReactNode;
+};
+
+declare const compileBuilderV2Output: (input: {
+    css?: unknown;
+    html?: unknown;
+}) => BuilderV2CompiledOutput;
+
+type BuilderV2PagePayloadDoc = BuilderV2PageData & {
+    id: number | string;
+};
+type CreateBuilderV2PageServiceArgs = {
+    collectionSlug?: string;
+    payload: Payload;
+    user: Record<string, unknown>;
+};
+type SaveBuilderV2PageInput = {
+    compiled: {
+        css?: string;
+        html?: string;
+    };
+    projectData: BuilderV2ProjectData;
+    title?: string;
+    validationIssues?: BuilderV2ValidationIssue[];
+};
+declare const toBuilderV2EditorInitialData: (page: BuilderV2PageData) => {
+    projectData: BuilderV2ProjectData;
+    title: string;
+};
+declare const createBuilderV2PageService: ({ collectionSlug, payload, user, }: CreateBuilderV2PageServiceArgs) => {
+    getPageForBuilder: (pageID: string) => Promise<{
+        id: string;
+        initialData: {
+            projectData: BuilderV2ProjectData;
+            title: string;
+        };
+        page: BuilderV2PagePayloadDoc;
+    }>;
+    saveDraft: (pageID: string, input: SaveBuilderV2PageInput) => Promise<{
+        compiled: BuilderV2CompiledOutput;
+        id: string;
+        status: "draft";
+    }>;
+    publish: (pageID: string, input: SaveBuilderV2PageInput) => Promise<{
+        compiled: BuilderV2CompiledOutput;
+        id: string;
+        status: "published";
+    }>;
+};
+
+declare const createEmptyBuilderV2ProjectData: (title?: string) => BuilderV2ProjectData;
+declare const normalizeBuilderV2ProjectData: (value: unknown, fallbackTitle?: string) => BuilderV2ProjectData;
+
+type PageLike = {
+    id: number | string;
+    parent?: number | string | {
+        id?: number | string;
+    } | null;
+    parentId?: number | string | null;
+    path?: string | null;
+    slug?: string | null;
+    title?: string | null;
+    _status?: 'draft' | 'published';
+};
+declare const buildBuilderV2PageTree: (pages: PageLike[]) => BuilderV2PageTreeNode[];
+
+declare function BuilderPageRuntime({ adapter, className, page }: BuilderV2RuntimeProps): react_jsx_runtime.JSX.Element;
+
+declare const parseBuilderV2DynamicComponents: (html: string) => BuilderV2DynamicComponentInstance[];
+declare const splitBuilderV2HtmlIntoChunks: (html: string) => BuilderV2RenderableChunk[];
+
+declare const sanitizeBuilderHtml: (value: unknown) => string;
+declare const sanitizeBuilderCss: (value: unknown) => string;
+declare const scopeBuilderCss: (value: unknown, scope?: string) => string;
+
+declare const validateBuilderV2Output: (input: {
+    css?: unknown;
+    html?: unknown;
+}) => BuilderV2ValidationIssue[];
+declare const hasBlockingBuilderV2Issues: (issues: BuilderV2ValidationIssue[]) => boolean;
+
+export { BuilderPageRuntime, type BuilderV2Asset, type BuilderV2CompiledOutput, type BuilderV2DynamicComponentInstance, type BuilderV2EditorInitialData, type BuilderV2FieldOptions, type BuilderV2Mode, type BuilderV2PageData, type BuilderV2PagePayloadDoc, type BuilderV2PageTreeNode, type BuilderV2PermissionSet, type BuilderV2ProjectAdapter, type BuilderV2ProjectComponentDefinition, type BuilderV2ProjectData, type BuilderV2RenderResult, type BuilderV2RenderableChunk, type BuilderV2RuntimeComponent, type BuilderV2RuntimeComponentProps, type BuilderV2RuntimeProps, type BuilderV2ThemeTokens, type BuilderV2TraitDefinition, type BuilderV2ValidationIssue, type BuilderV2VersionSnapshot, type CreateBuilderV2PageServiceArgs, type SaveBuilderV2PageInput, appendBuilderV2PageFields, buildBuilderV2PageTree, compileBuilderV2Output, createBuilderV2PageFields, createBuilderV2PageService, createEmptyBuilderV2ProjectData, hasBlockingBuilderV2Issues, normalizeBuilderV2ProjectData, parseBuilderV2DynamicComponents, sanitizeBuilderCss, sanitizeBuilderHtml, scopeBuilderCss, splitBuilderV2HtmlIntoChunks, toBuilderV2EditorInitialData, validateBuilderV2Output };