@phenix1024/editor 0.0.0-stage → 0.2.0

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

@@ -0,0 +1,30 @@
+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. */
+export declare const OphxBlockField: Node<any, any>;
+/** Preserves a readonly inline span while allowing editable field descendants. */
+export declare const OphxReadonlyInline: Mark<any, any>;
+/** A readonly block container can still contain nested editable template fields. */
+export declare const OphxReadonlyBlock: Node<any, any>;
+export declare const CollapsibleHeading: Node<import("@tiptap/extension-heading").HeadingOptions, any>;
+type SearchStorage = {
+    query: string;
+};
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        ophxSearch: {
+            setSearchQuery: (query: string) => ReturnType;
+        };
+    }
+}
+export declare const TextSearch: Extension<SearchStorage, any>;
+export declare const WysiwymRules: Extension<any, any>;
+export declare const Indentation: Extension<any, any>;
+/** Retains v2 contenteditable overrides on schema nodes and marks. */
+export declare const OphxEditability: Extension<any, any>;
+export declare function isValidOphxFieldId(value: string): boolean;
+export {};

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

@@ -0,0 +1,27 @@
+export interface OphxDocument {
+    /** Sanitized body HTML ready for the Tiptap schema. */
+    html: string;
+    title: string;
+    /** Basename of the required root-level HTML entry, without extension. */
+    filename: string;
+    /** Local stylesheet files keyed by their exact archive filename. */
+    styles: Record<string, string>;
+    /** Convenience alias for the first stylesheet, if present. */
+    css: string;
+    bodyContentEditable?: 'true' | 'false';
+}
+export interface OphxExportOptions {
+    /** Basename used for both the outer .ophx file and the root-level HTML file. */
+    filename?: string;
+    title?: string;
+    /** Flat stylesheet filenames mapped to CSS source. */
+    styles?: Record<string, string>;
+    /** Files for already-referenced local image names, keyed by exact archive filename. */
+    assets?: Record<string, Blob | Uint8Array | ArrayBuffer>;
+    bodyContentEditable?: 'true' | 'false';
+}
+/** Creates a v2 .ophx ZIP using only flat, UTF-8-named STORE/DEFLATE entries. */
+export declare function exportOphx(html: string, options?: OphxExportOptions): Promise<Blob>;
+/** Reads only current v2 archives; legacy non-ZIP/XML formats are rejected. */
+export declare function importOphx(file: Blob): Promise<OphxDocument>;
+export declare function downloadBlob(blob: Blob, filename: string): void;

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

@@ -0,0 +1,70 @@
+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;
+    required: boolean;
+    value: string;
+}
+export interface OphxEditorOptions {
+    /** 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>>)[]>[]>;
+    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[];
+    destroy(): void;
+}

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

@@ -0,0 +1,2 @@
+declare const stylesheet: string
+export default stylesheet

package/dist/types/editor/template-fields.d.ts

@@ -0,0 +1,7 @@
+export interface UnderscoreFieldConversion {
+    html: string;
+    count: number;
+    ids: string[];
+}
+/** Replaces each run of two or more underscores in editable text with an empty v2 field. */
+export declare function convertUnderscoresToFields(html: string, prefix?: string): UnderscoreFieldConversion;

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

@@ -0,0 +1,6 @@
+import { type Editor } from '@tiptap/core';
+export interface ToolbarOptions {
+    onInsertImage?: (file: File) => void;
+}
+/** Mounts an optional accessible toolbar; consumers can provide their own UI instead. */
+export declare function mountToolbar(host: HTMLElement, editor: Editor, options?: ToolbarOptions): () => void;

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+import './editor/ophx.css';
+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';
+export { convertUnderscoresToFields, type UnderscoreFieldConversion } from './editor/template-fields';

package/package.json

@@ -1,6 +1,83 @@
 {
   "name": "@phenix1024/editor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "private": false,
+  "version": "0.2.0",
+  "description": "Framework-agnostic WYSIWYM document editor and .ophx archive tools, powered by Tiptap",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/ophx-editor.cjs",
+  "module": "./dist/ophx-editor.js",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/ophx-editor.js",
+      "require": "./dist/ophx-editor.cjs"
+    },
+    "./style.css": "./dist/ophx-editor.css",
+    "./standalone": {
+      "import": "./dist/ophx-editor.standalone.js",
+      "default": "./dist/ophx-editor.iife.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "unpkg": "./dist/ophx-editor.iife.js",
+  "jsdelivr": "./dist/ophx-editor.iife.js",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mars102/pluginEditor.git"
+  },
+  "homepage": "https://github.com/mars102/pluginEditor#readme",
+  "bugs": {
+    "url": "https://github.com/mars102/pluginEditor/issues"
+  },
+  "keywords": [
+    "tiptap",
+    "editor",
+    "wysiwyg",
+    "wysiwym",
+    "ophx",
+    "document-editor"
+  ],
+  "author": "mars102",
+  "scripts": {
+    "dev": "vite",
+    "build": "rm -rf dist dist-demo && npm run typecheck && vite build --config vite.config.ts && tsc -p tsconfig.types.json && node scripts/copy-css-types.mjs && vite build --config vite.lib.config.ts && vite build --config vite.standalone.config.ts && rm -f dist/favicon.svg dist/icons.svg",
+    "build:demo": "vite build --config vite.config.ts",
+    "build:lib": "rm -rf dist && npm run typecheck && tsc -p tsconfig.types.json && node scripts/copy-css-types.mjs && vite build --config vite.lib.config.ts && vite build --config vite.standalone.config.ts && rm -f dist/favicon.svg dist/icons.svg",
+    "preview": "vite preview",
+    "typecheck": "tsc --noEmit",
+    "prepare": "npm run build:lib",
+    "prepublishOnly": "npm run build:lib"
+  },
+  "devDependencies": {
+    "typescript": "~7.0.2",
+    "vite": "^8.3.6"
+  },
+  "dependencies": {
+    "@tiptap/core": "^3.33.0",
+    "@tiptap/extension-heading": "^3.33.0",
+    "@tiptap/extension-image": "^3.33.0",
+    "@tiptap/extension-link": "^3.33.0",
+    "@tiptap/extension-placeholder": "^3.33.0",
+    "@tiptap/extension-table": "^3.33.0",
+    "@tiptap/extension-table-cell": "^3.33.0",
+    "@tiptap/extension-table-header": "^3.33.0",
+    "@tiptap/extension-table-row": "^3.33.0",
+    "@tiptap/extension-underline": "^3.33.0",
+    "@tiptap/pm": "^3.33.0",
+    "@tiptap/starter-kit": "^3.33.0",
+    "jszip": "^3.10.2"
+  }
+}