@templatical/core 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,148 @@
+import { TemplateContent, ViewportSize, TemplateDefaults, Block, TemplateSettings, BlockDefaults, BlockType, CustomBlockDefinition, CustomBlock } from '@templatical/types';
+import { Ref, DeepReadonly, ComputedRef } from '@vue/reactivity';
+
+interface EditorState {
+    content: TemplateContent;
+    selectedBlockId: string | null;
+    viewport: ViewportSize;
+    darkMode: boolean;
+    previewMode: boolean;
+    isDirty: boolean;
+}
+interface UseEditorOptions {
+    content: TemplateContent;
+    defaultFontFamily?: string;
+    templateDefaults?: TemplateDefaults;
+    lockedBlocks?: Ref<Map<string, unknown>>;
+}
+interface UseEditorReturn {
+    state: DeepReadonly<EditorState>;
+    content: Ref<TemplateContent>;
+    selectedBlock: Ref<Block | null>;
+    setContent: (content: TemplateContent, markDirty?: boolean) => void;
+    selectBlock: (blockId: string | null) => void;
+    setViewport: (viewport: ViewportSize) => void;
+    setDarkMode: (darkMode: boolean) => void;
+    setPreviewMode: (previewMode: boolean) => void;
+    updateBlock: (blockId: string, updates: Partial<Block>) => void;
+    updateSettings: (updates: Partial<TemplateSettings>) => void;
+    addBlock: (block: Block, targetSectionId?: string, columnIndex?: number, index?: number) => void;
+    removeBlock: (blockId: string) => void;
+    moveBlock: (blockId: string, newIndex: number, targetSectionId?: string, columnIndex?: number) => void;
+    isBlockLocked: (blockId: string) => boolean;
+    markDirty: () => void;
+}
+declare function useEditor(options: UseEditorOptions): UseEditorReturn;
+
+interface UseHistoryOptions {
+    content: Ref<TemplateContent>;
+    setContent: (content: TemplateContent, markDirty?: boolean) => void;
+    isRemoteOperation?: () => boolean;
+    maxSize?: number;
+}
+interface UseHistoryReturn {
+    canUndo: ComputedRef<boolean>;
+    canRedo: ComputedRef<boolean>;
+    isNavigating: Ref<boolean>;
+    undo: () => void;
+    redo: () => void;
+    record: () => void;
+    recordDebounced: (blockId: string) => void;
+    clear: () => void;
+    destroy: () => void;
+}
+declare function useHistory(options: UseHistoryOptions): UseHistoryReturn;
+
+interface UseBlockActionsOptions {
+    addBlock: (block: Block, targetSectionId?: string, columnIndex?: number) => void;
+    removeBlock: (blockId: string) => void;
+    updateBlock: (blockId: string, updates: Partial<Block>) => void;
+    selectBlock: (blockId: string | null) => void;
+    blockDefaults?: BlockDefaults;
+}
+interface UseBlockActionsReturn {
+    createAndAddBlock: (type: BlockType, targetSectionId?: string, columnIndex?: number) => Block;
+    duplicateBlock: (block: Block, targetSectionId?: string, columnIndex?: number) => Block;
+    deleteBlock: (blockId: string) => void;
+    updateBlockProperty: <K extends keyof Block>(blockId: string, key: K, value: Block[K]) => void;
+}
+declare function useBlockActions(options: UseBlockActionsOptions): UseBlockActionsReturn;
+
+interface UseAutoSaveOptions {
+    content: Ref<TemplateContent>;
+    isDirty: () => boolean;
+    onChange: (content: TemplateContent) => void;
+    debounce?: number;
+    enabled?: boolean | (() => boolean);
+}
+interface UseAutoSaveReturn {
+    flush: () => void;
+    cancel: () => void;
+    pause: () => void;
+    resume: () => void;
+    destroy: () => void;
+}
+declare function useAutoSave(options: UseAutoSaveOptions): UseAutoSaveReturn;
+
+interface UseConditionPreviewReturn {
+    isHidden: (blockId: string) => boolean;
+    toggleBlock: (blockId: string) => void;
+    reset: () => void;
+    hasHiddenBlocks: ComputedRef<boolean>;
+}
+declare function useConditionPreview(editor: UseEditorReturn): UseConditionPreviewReturn;
+
+declare function useDataSourceFetch(options: {
+    definition: ComputedRef<CustomBlockDefinition | undefined>;
+    block: ComputedRef<CustomBlock>;
+    onUpdate: (fieldValues: Record<string, unknown>, fetched: boolean) => void;
+}): {
+    isFetching: Ref<boolean>;
+    fetchError: Ref<boolean>;
+    fetch: () => Promise<void>;
+    hasDataSource: ComputedRef<boolean>;
+    needsFetch: ComputedRef<boolean>;
+};
+
+interface EditorPlugin {
+    name: string;
+    install(context: EditorPluginContext): void | Promise<void>;
+    destroy?(): void;
+}
+interface EditorPluginContext {
+    readonly state: DeepReadonly<EditorState>;
+    readonly content: Ref<TemplateContent>;
+    readonly selectedBlockId: DeepReadonly<EditorState>["selectedBlockId"];
+    readonly viewport: DeepReadonly<EditorState>["viewport"];
+    addBlock(block: Block, targetSectionId?: string, columnIndex?: number, index?: number): void;
+    updateBlock(blockId: string, updates: Partial<Block>): void;
+    removeBlock(blockId: string): void;
+    moveBlock(blockId: string, newIndex: number, targetSectionId?: string, columnIndex?: number): void;
+    updateSettings(updates: Partial<TemplateSettings>): void;
+    selectBlock(blockId: string | null): void;
+    registerToolbarAction(action: ToolbarAction): void;
+    registerSidebarPanel(panel: SidebarPanel): void;
+    registerBlockAction(action: BlockContextAction): void;
+}
+interface ToolbarAction {
+    id: string;
+    icon: string;
+    label: string;
+    onClick: () => void;
+    position?: "left" | "right";
+}
+interface SidebarPanel {
+    id: string;
+    icon: string;
+    label: string;
+    component: unknown;
+    position?: "left" | "right";
+}
+interface BlockContextAction {
+    id: string;
+    icon: string;
+    label: string;
+    onClick: (blockId: string) => void;
+}
+
+export { type BlockContextAction, type EditorPlugin, type EditorPluginContext, type EditorState, type SidebarPanel, type ToolbarAction, type UseAutoSaveOptions, type UseAutoSaveReturn, type UseBlockActionsOptions, type UseBlockActionsReturn, type UseConditionPreviewReturn, type UseEditorOptions, type UseEditorReturn, type UseHistoryOptions, type UseHistoryReturn, useAutoSave, useBlockActions, useConditionPreview, useDataSourceFetch, useEditor, useHistory };

package/dist/index.d.ts

@@ -0,0 +1,148 @@
+import { TemplateContent, ViewportSize, TemplateDefaults, Block, TemplateSettings, BlockDefaults, BlockType, CustomBlockDefinition, CustomBlock } from '@templatical/types';
+import { Ref, DeepReadonly, ComputedRef } from '@vue/reactivity';
+
+interface EditorState {
+    content: TemplateContent;
+    selectedBlockId: string | null;
+    viewport: ViewportSize;
+    darkMode: boolean;
+    previewMode: boolean;
+    isDirty: boolean;
+}
+interface UseEditorOptions {
+    content: TemplateContent;
+    defaultFontFamily?: string;
+    templateDefaults?: TemplateDefaults;
+    lockedBlocks?: Ref<Map<string, unknown>>;
+}
+interface UseEditorReturn {
+    state: DeepReadonly<EditorState>;
+    content: Ref<TemplateContent>;
+    selectedBlock: Ref<Block | null>;
+    setContent: (content: TemplateContent, markDirty?: boolean) => void;
+    selectBlock: (blockId: string | null) => void;
+    setViewport: (viewport: ViewportSize) => void;
+    setDarkMode: (darkMode: boolean) => void;
+    setPreviewMode: (previewMode: boolean) => void;
+    updateBlock: (blockId: string, updates: Partial<Block>) => void;
+    updateSettings: (updates: Partial<TemplateSettings>) => void;
+    addBlock: (block: Block, targetSectionId?: string, columnIndex?: number, index?: number) => void;
+    removeBlock: (blockId: string) => void;
+    moveBlock: (blockId: string, newIndex: number, targetSectionId?: string, columnIndex?: number) => void;
+    isBlockLocked: (blockId: string) => boolean;
+    markDirty: () => void;
+}
+declare function useEditor(options: UseEditorOptions): UseEditorReturn;
+
+interface UseHistoryOptions {
+    content: Ref<TemplateContent>;
+    setContent: (content: TemplateContent, markDirty?: boolean) => void;
+    isRemoteOperation?: () => boolean;
+    maxSize?: number;
+}
+interface UseHistoryReturn {
+    canUndo: ComputedRef<boolean>;
+    canRedo: ComputedRef<boolean>;
+    isNavigating: Ref<boolean>;
+    undo: () => void;
+    redo: () => void;
+    record: () => void;
+    recordDebounced: (blockId: string) => void;
+    clear: () => void;
+    destroy: () => void;
+}
+declare function useHistory(options: UseHistoryOptions): UseHistoryReturn;
+
+interface UseBlockActionsOptions {
+    addBlock: (block: Block, targetSectionId?: string, columnIndex?: number) => void;
+    removeBlock: (blockId: string) => void;
+    updateBlock: (blockId: string, updates: Partial<Block>) => void;
+    selectBlock: (blockId: string | null) => void;
+    blockDefaults?: BlockDefaults;
+}
+interface UseBlockActionsReturn {
+    createAndAddBlock: (type: BlockType, targetSectionId?: string, columnIndex?: number) => Block;
+    duplicateBlock: (block: Block, targetSectionId?: string, columnIndex?: number) => Block;
+    deleteBlock: (blockId: string) => void;
+    updateBlockProperty: <K extends keyof Block>(blockId: string, key: K, value: Block[K]) => void;
+}
+declare function useBlockActions(options: UseBlockActionsOptions): UseBlockActionsReturn;
+
+interface UseAutoSaveOptions {
+    content: Ref<TemplateContent>;
+    isDirty: () => boolean;
+    onChange: (content: TemplateContent) => void;
+    debounce?: number;
+    enabled?: boolean | (() => boolean);
+}
+interface UseAutoSaveReturn {
+    flush: () => void;
+    cancel: () => void;
+    pause: () => void;
+    resume: () => void;
+    destroy: () => void;
+}
+declare function useAutoSave(options: UseAutoSaveOptions): UseAutoSaveReturn;
+
+interface UseConditionPreviewReturn {
+    isHidden: (blockId: string) => boolean;
+    toggleBlock: (blockId: string) => void;
+    reset: () => void;
+    hasHiddenBlocks: ComputedRef<boolean>;
+}
+declare function useConditionPreview(editor: UseEditorReturn): UseConditionPreviewReturn;
+
+declare function useDataSourceFetch(options: {
+    definition: ComputedRef<CustomBlockDefinition | undefined>;
+    block: ComputedRef<CustomBlock>;
+    onUpdate: (fieldValues: Record<string, unknown>, fetched: boolean) => void;
+}): {
+    isFetching: Ref<boolean>;
+    fetchError: Ref<boolean>;
+    fetch: () => Promise<void>;
+    hasDataSource: ComputedRef<boolean>;
+    needsFetch: ComputedRef<boolean>;
+};
+
+interface EditorPlugin {
+    name: string;
+    install(context: EditorPluginContext): void | Promise<void>;
+    destroy?(): void;
+}
+interface EditorPluginContext {
+    readonly state: DeepReadonly<EditorState>;
+    readonly content: Ref<TemplateContent>;
+    readonly selectedBlockId: DeepReadonly<EditorState>["selectedBlockId"];
+    readonly viewport: DeepReadonly<EditorState>["viewport"];
+    addBlock(block: Block, targetSectionId?: string, columnIndex?: number, index?: number): void;
+    updateBlock(blockId: string, updates: Partial<Block>): void;
+    removeBlock(blockId: string): void;
+    moveBlock(blockId: string, newIndex: number, targetSectionId?: string, columnIndex?: number): void;
+    updateSettings(updates: Partial<TemplateSettings>): void;
+    selectBlock(blockId: string | null): void;
+    registerToolbarAction(action: ToolbarAction): void;
+    registerSidebarPanel(panel: SidebarPanel): void;
+    registerBlockAction(action: BlockContextAction): void;
+}
+interface ToolbarAction {
+    id: string;
+    icon: string;
+    label: string;
+    onClick: () => void;
+    position?: "left" | "right";
+}
+interface SidebarPanel {
+    id: string;
+    icon: string;
+    label: string;
+    component: unknown;
+    position?: "left" | "right";
+}
+interface BlockContextAction {
+    id: string;
+    icon: string;
+    label: string;
+    onClick: (blockId: string) => void;
+}
+
+export { type BlockContextAction, type EditorPlugin, type EditorPluginContext, type EditorState, type SidebarPanel, type ToolbarAction, type UseAutoSaveOptions, type UseAutoSaveReturn, type UseBlockActionsOptions, type UseBlockActionsReturn, type UseConditionPreviewReturn, type UseEditorOptions, type UseEditorReturn, type UseHistoryOptions, type UseHistoryReturn, useAutoSave, useBlockActions, useConditionPreview, useDataSourceFetch, useEditor, useHistory };