@phenix1024/editor 0.1.0 → 0.2.0

package/dist/types/editor/extensions.d.ts

@@ -1,5 +1,7 @@
 import { Extension, Mark, Node } from '@tiptap/core';
 export declare const Label: Mark<any, any>;
+/** Image node with portable width and text-wrapping attributes. */
+export declare const OphxImage: Node<import("@tiptap/extension-image").ImageOptions, any>;
 /** Inline template field: its textual value stays editable inside the editor. */
 export declare const OphxInlineField: Node<any, any>;
 /** Block template field, accepting the v2 <p> and <div> wrapper forms. */

package/dist/types/editor/ophx-editor.d.ts

@@ -1,4 +1,6 @@
 import { Editor, type Content, type EditorOptions } from '@tiptap/core';
+import { type ToolbarOptions } from './toolbar';
+import { type OphxDocument, type OphxExportOptions } from './ophx-archive';
 export interface OphxFieldValue {
     id: string;
     label: string | null;
@@ -6,20 +8,61 @@ export interface OphxFieldValue {
     value: string;
 }
 export interface OphxEditorOptions {
-    element: HTMLElement;
+    /** Container for the document: an element or a CSS selector. */
+    element: HTMLElement | string;
+    /**
+     * Built-in toolbar container (element or CSS selector). When set, the toolbar is mounted
+     * automatically and removed by destroy().
+     */
+    toolbar?: HTMLElement | string;
+    /** Options for the built-in toolbar, e.g. a custom image upload handler. */
+    toolbarOptions?: ToolbarOptions;
     content?: Content;
     placeholder?: string;
+    /** Initial mode when nothing is stored yet. Defaults to true. */
     editable?: boolean;
+    /**
+     * localStorage key used to remember the edit/view mode across reloads.
+     * Defaults to 'ophx-editor-editable'. Pass null to disable persistence.
+     */
+    editableStorageKey?: string | null;
     onUpdate?: EditorOptions['onUpdate'];
     extensions?: NonNullable<EditorOptions['extensions']>;
 }
+export interface OphxSetContentOptions {
+    /** Emit Tiptap's update event after replacing the document. Defaults to false. */
+    emitUpdate?: boolean;
+}
 /** A framework-neutral Tiptap editor wrapper. UI is intentionally optional. */
 export declare class OphxEditor {
     readonly editor: Editor;
+    private archiveDefaults;
+    private readonly editableStorageKey;
+    private unmountToolbar;
     constructor(options: OphxEditorOptions);
     getHTML(): string;
     getJSON(): import("@tiptap/core").DocumentType<Record<string, any> | undefined, import("@tiptap/core").NodeType<string, Record<string, any> | undefined, any, (import("@tiptap/core").NodeType<any, any, any, any> | import("@tiptap/core").TextType<import("@tiptap/core").MarkType<any, any>>)[]>[]>;
-    setContent(content: Content): void;
+    getText(): string;
+    get isEmpty(): boolean;
+    get isEditable(): boolean;
+    setContent(content: Content, options?: OphxSetContentOptions): void;
+    clearContent(options?: OphxSetContentOptions): void;
+    focus(position?: 'start' | 'end' | 'all' | number): this;
+    blur(): this;
+    setEditable(editable: boolean): this;
+    private readStoredEditable;
+    private writeStoredEditable;
+    undo(): boolean;
+    redo(): boolean;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    private syncEditableControls;
+    /** Parse and load an .ophx archive; the archive's metadata becomes the default for saveOphx(). */
+    loadOphx(file: Blob): Promise<OphxDocument>;
+    /** Create an .ophx archive Blob; callers can persist it or pass it to downloadBlob(). */
+    saveOphx(options?: OphxExportOptions): Promise<Blob>;
+    /** Trigger a browser download of the current document as an .ophx archive. */
+    downloadOphx(options?: OphxExportOptions): Promise<void>;
     setSearchQuery(query: string): void;
     getFields(): OphxFieldValue[];
     getMissingRequiredFields(): OphxFieldValue[];

package/dist/types/editor/toolbar.d.ts

@@ -1,4 +1,4 @@
-import type { Editor } from '@tiptap/core';
+import { type Editor } from '@tiptap/core';
 export interface ToolbarOptions {
     onInsertImage?: (file: File) => void;
 }

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import './editor/ophx.css';
-export { OphxEditor, type OphxEditorOptions, type OphxFieldValue } from './editor/ophx-editor';
+export { OphxEditor, type OphxEditorOptions, type OphxFieldValue, type OphxSetContentOptions } from './editor/ophx-editor';
 export { mountToolbar, type ToolbarOptions } from './editor/toolbar';
 export { exportOphx, importOphx, downloadBlob, type OphxDocument, type OphxExportOptions, } from './editor/ophx-archive';
 export { CollapsibleHeading, Indentation, Label, OphxBlockField, OphxEditability, OphxInlineField, OphxReadonlyBlock, OphxReadonlyInline, TextSearch, WysiwymRules, isValidOphxFieldId, } from './editor/extensions';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@phenix1024/editor",
   "private": false,
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Framework-agnostic WYSIWYM document editor and .ophx archive tools, powered by Tiptap",
   "license": "MIT",
   "type": "module",