@standhigher/puck-page-builder 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,182 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { ExtensionRegistry } from './extensions.js';
+export { BlockDefinition, DataSourceDefinition, EditorAction, EditorActionPosition, ExtensionActionContext, ExtensionRegistryError, ExtensionRegistryErrorCode, ExtensionRegistryOptions, ExtensionTarget, FieldConfig, FieldDefinition, FieldProps, LifecycleHooks, PageBuilderExtension, RendererDefinition, TemplateDefinition, UISlotContribution, UISlotName, ValidationIssue, createExtensionRegistry } from './extensions.js';
+import { PageDocument, BlockNode, JsonValue } from './schema.js';
+export { DataBinding, PageDocumentIssue, PageDocumentMigration, PageSettings, RenderTarget, createPageDocument, migratePageDocument, validatePageDocument } from './schema.js';
+import { Data } from '@puckeditor/core';
+export { WebRenderer, WebRendererProps } from './renderer.js';
+
+type BlockView = "blocks" | "outline";
+type Device = "desktop" | "tablet" | "mobile" | "full";
+type Zoom = "auto" | "50" | "70" | "100";
+type SaveState = "clean" | "dirty" | "saving" | "saved" | "failed" | "conflict";
+type PreviewMode = "editor" | "mock-preview" | "live-preview";
+type PublishState = "draft" | "publishing" | "published" | "publish-failed";
+type DemoBlock = {
+    id: string;
+    type: "Hero" | "TrackingForm" | "Text";
+    label: string;
+    description: string;
+    title: string;
+    body: string;
+};
+type EditorState = {
+    blocks: DemoBlock[];
+    selectedBlockId: string | null;
+    blockView: BlockView;
+    device: Device;
+    zoom: Zoom;
+    saveState: SaveState;
+    previewMode: PreviewMode;
+    publishState: PublishState;
+    editorLocale: string;
+    pageLocale: string;
+    isPickerOpen: boolean;
+    isLeftRailOpen: boolean;
+    isRightPanelOpen: boolean;
+};
+
+type EditorShellProps = {
+    initialState?: Partial<EditorState>;
+    iframe?: boolean;
+};
+declare function EditorShell({ initialState, iframe }: EditorShellProps): react.JSX.Element;
+
+type EditorLoadState = "loading" | "ready" | "empty" | "error" | "disabled" | "success";
+type EditorActionState = {
+    canUndo: boolean;
+    canRedo: boolean;
+    canAdd: boolean;
+    canEdit: boolean;
+    canDelete: boolean;
+    canDuplicate: boolean;
+    canReorder: boolean;
+};
+type EditorContextValue = {
+    document: PageDocument;
+    selectedBlockId: string | null;
+    selectedBlock: BlockNode | null;
+    canvasSelectionRequest: string | null;
+    device: Device;
+    loadState: EditorLoadState;
+    isDirty: boolean;
+    actionState: EditorActionState;
+    /** Request a canvas selection. The inspector changes only after Puck confirms it. */
+    requestCanvasSelection(id: string): void;
+    /** Called from the canvas/Puck selection event. */
+    confirmCanvasSelection(id: string | null): void;
+    /** Applies an edit that originated in the canvas engine. */
+    updateFromCanvas(document: PageDocument): void;
+    setDevice(device: Device): void;
+    addBlock(type: string, beforeId?: string): string | null;
+    duplicateBlock(id: string): void;
+    deleteBlock(id: string): void;
+    moveBlock(id: string, direction: -1 | 1): void;
+    reorderBlock(id: string, beforeId: string): void;
+    updateBlockProps(id: string, props: Record<string, JsonValue>): void;
+    undo(): void;
+    redo(): void;
+    markSaved(): void;
+};
+declare function EditorProvider({ initialDocument, registry, loadState, leaveWarning, onDocumentChange, children }: {
+    initialDocument: PageDocument;
+    registry?: ExtensionRegistry;
+    loadState?: EditorLoadState;
+    leaveWarning?: string;
+    onDocumentChange?: (document: PageDocument) => void;
+    children: ReactNode;
+}): react.JSX.Element;
+declare function useEditorContext(): EditorContextValue;
+
+type PageDocumentEditorShellProps = {
+    initialDocument: PageDocument;
+    iframe?: boolean;
+    registry?: ExtensionRegistry;
+    /** Presentation states are explicit so host applications can provide a consistent Admin experience. */
+    loadState?: EditorLoadState;
+    adminLocale?: string;
+    onDocumentChange?: (document: PageDocument) => void;
+    /** Persist the current draft. The shell marks the document clean only after this resolves. */
+    onSave?: (document: PageDocument) => Promise<void> | void;
+    /** Publish the current document. Hosts should persist it atomically with publication. */
+    onPublish?: (document: PageDocument) => Promise<void> | void;
+};
+declare function PageDocumentEditorShell(props: PageDocumentEditorShellProps): react.JSX.Element;
+
+type AdminLocale = "zh-CN" | "en";
+declare const messages: {
+    readonly "zh-CN": {
+        readonly blocks: "区块";
+        readonly outline: "结构";
+        readonly properties: "属性";
+        readonly addBlock: "添加区块";
+        readonly undo: "撤销";
+        readonly redo: "恢复";
+        readonly duplicate: "复制";
+        readonly remove: "删除";
+        readonly moveUp: "上移";
+        readonly moveDown: "下移";
+        readonly loading: "正在加载编辑器…";
+        readonly empty: "页面还没有区块";
+        readonly error: "编辑器无法加载";
+        readonly disabled: "编辑器当前不可编辑";
+        readonly success: "操作已完成";
+        readonly unsaved: "未保存变更";
+        readonly saved: "所有更改已保留在当前会话中";
+        readonly save: "保存草稿";
+        readonly saving: "正在保存…";
+        readonly publish: "发布";
+        readonly publishing: "正在发布…";
+        readonly saveFailed: "保存草稿失败";
+        readonly publishFailed: "发布失败";
+        readonly published: "已发布";
+        readonly leaveWarning: "你有未保存的更改。确定要离开吗？";
+        readonly selectBlock: "选择一个区块以编辑。";
+        readonly desktop: "桌面";
+        readonly tablet: "平板";
+        readonly mobile: "手机";
+    };
+    readonly en: {
+        readonly blocks: "Blocks";
+        readonly outline: "Outline";
+        readonly properties: "Properties";
+        readonly addBlock: "Add block";
+        readonly undo: "Undo";
+        readonly redo: "Redo";
+        readonly duplicate: "Duplicate";
+        readonly remove: "Delete";
+        readonly moveUp: "Move up";
+        readonly moveDown: "Move down";
+        readonly loading: "Loading editor…";
+        readonly empty: "This page has no blocks";
+        readonly error: "The editor could not load";
+        readonly disabled: "The editor is currently read-only";
+        readonly success: "Action completed";
+        readonly unsaved: "Unsaved changes";
+        readonly saved: "Changes are kept in this session";
+        readonly save: "Save draft";
+        readonly saving: "Saving…";
+        readonly publish: "Publish";
+        readonly publishing: "Publishing…";
+        readonly saveFailed: "Could not save draft";
+        readonly publishFailed: "Could not publish";
+        readonly published: "Published";
+        readonly leaveWarning: "You have unsaved changes. Are you sure you want to leave?";
+        readonly selectBlock: "Select a block to edit it.";
+        readonly desktop: "Desktop";
+        readonly tablet: "Tablet";
+        readonly mobile: "Mobile";
+    };
+};
+type AdminMessageKey = keyof typeof messages["zh-CN"];
+/** Minimal, dependency-free Admin copy catalog. Product locale remains PageDocument.settings.locale. */
+declare function createAdminI18n(locale?: string): {
+    locale: AdminLocale;
+    t: (key: AdminMessageKey) => "Desktop" | "Tablet" | "Mobile" | "未保存变更" | "Outline" | "区块" | "结构" | "撤销" | "恢复" | "属性" | "添加区块" | "复制" | "删除" | "上移" | "下移" | "正在加载编辑器…" | "页面还没有区块" | "编辑器无法加载" | "编辑器当前不可编辑" | "操作已完成" | "所有更改已保留在当前会话中" | "保存草稿" | "正在保存…" | "发布" | "正在发布…" | "保存草稿失败" | "发布失败" | "已发布" | "你有未保存的更改。确定要离开吗？" | "选择一个区块以编辑。" | "桌面" | "平板" | "手机" | "Blocks" | "Properties" | "Add block" | "Undo" | "Redo" | "Duplicate" | "Delete" | "Move up" | "Move down" | "Loading editor…" | "This page has no blocks" | "The editor could not load" | "The editor is currently read-only" | "Action completed" | "Unsaved changes" | "Changes are kept in this session" | "Save draft" | "Saving…" | "Publish" | "Publishing…" | "Could not save draft" | "Could not publish" | "Published" | "You have unsaved changes. Are you sure you want to leave?" | "Select a block to edit it.";
+};
+
+declare function toEngineData(document: PageDocument, registry?: ExtensionRegistry): Data;
+declare function fromEngineData(data: Data, base: PageDocument, registry?: ExtensionRegistry): PageDocument;
+
+export { type AdminLocale, type AdminMessageKey, BlockNode, type DemoBlock, type Device, type EditorActionState, type EditorLoadState, EditorProvider, EditorShell, type EditorShellProps, type EditorState, ExtensionRegistry, JsonValue, PageDocument, PageDocumentEditorShell, type PageDocumentEditorShellProps, type PreviewMode, type PublishState, type SaveState, type Zoom, createAdminI18n, fromEngineData, toEngineData, useEditorContext };