react-next-editor-js 0.1.0

package/dist/types-B4z0Quvv.d.cts

@@ -0,0 +1,193 @@
+/**
+ * Public configuration types for the editor.
+ *
+ * The entire editor is driven by a single, documented configuration object
+ * (F-10.1). Every field is optional; sensible defaults are applied by
+ * {@link resolveConfig}. Feature flags (F-10.2), page setup, theming (F-10.5),
+ * localized strings (F-10.8) and injectable adapters (F-10.12) are all expressed
+ * here so an integration can enable only what it needs without forking.
+ */
+/** ProseMirror document JSON. Kept structural so consumers don't import PM types. */
+type DocumentJSON = {
+    type: string;
+    content?: DocumentJSON[];
+    attrs?: Record<string, unknown>;
+    marks?: Array<{
+        type: string;
+        attrs?: Record<string, unknown>;
+    }>;
+    text?: string;
+};
+/** The editing surface mode (F-10.3). `comment`/`suggest` are reserved for future use. */
+type EditorMode = 'edit' | 'readonly';
+/**
+ * Individually toggleable features (F-10.2). Omitted flags fall back to
+ * {@link DEFAULT_FEATURES}. Disabling a feature removes its schema nodes/marks,
+ * commands, input rules and toolbar items together.
+ */
+interface FeatureFlags {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strikethrough: boolean;
+    superscript: boolean;
+    subscript: boolean;
+    code: boolean;
+    fontFamily: boolean;
+    fontSize: boolean;
+    textColor: boolean;
+    highlight: boolean;
+    clearFormatting: boolean;
+    headings: boolean;
+    alignment: boolean;
+    lineSpacing: boolean;
+    indentation: boolean;
+    bulletList: boolean;
+    orderedList: boolean;
+    taskList: boolean;
+    blockquote: boolean;
+    horizontalRule: boolean;
+    table: boolean;
+    image: boolean;
+    link: boolean;
+    pageBreak: boolean;
+    history: boolean;
+    wordCount: boolean;
+    docxImport: boolean;
+}
+/** Standard page sizes plus a custom escape hatch. */
+type PageSize = 'A4' | 'Letter' | 'Legal' | 'A5' | 'custom';
+/** Page geometry, in millimetres unless `size` is `custom` with explicit dimensions. */
+interface PageConfig {
+    size: PageSize;
+    /** Used only when `size === 'custom'`. Width in mm. */
+    widthMm?: number;
+    /** Used only when `size === 'custom'`. Height in mm. */
+    heightMm?: number;
+    orientation: 'portrait' | 'landscape';
+    margins: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    /** Show the page as a white sheet on a canvas background (single-flow model). */
+    showPageChrome: boolean;
+    /**
+     * Pagination model (§10.1). `'none'` (default) is the document-styled single
+     * flow; `'visual'` splits content across discrete on-screen page sheets with
+     * repeating headers/footers and live page numbers (F-5.3–F-5.5).
+     */
+    pagination?: 'none' | 'visual';
+    /** Repeating page header (visual pagination only). */
+    header?: PageRunningElement;
+    /** Repeating page footer (visual pagination only). */
+    footer?: PageFooterElement;
+}
+/** A repeating page header/footer element (visual pagination). */
+interface PageRunningElement {
+    show?: boolean;
+    /** Static text; `{page}` and `{pages}` are replaced with the live numbers. */
+    text?: string;
+    align?: 'left' | 'center' | 'right';
+}
+/** A repeating page footer, optionally showing automatic page numbers (F-5.5). */
+interface PageFooterElement extends PageRunningElement {
+    /** Show "Page X of Y" automatically when no explicit `text` is given. */
+    pageNumbers?: boolean;
+}
+/**
+ * Design tokens exposed as CSS custom properties (F-10.5). Any subset can be
+ * supplied; unspecified tokens inherit the stylesheet defaults. Consumers theme
+ * the editor without editing component source.
+ */
+interface ThemeTokens {
+    fontFamily?: string;
+    fontSize?: string;
+    textColor?: string;
+    background?: string;
+    canvasBackground?: string;
+    pageBackground?: string;
+    accent?: string;
+    toolbarBackground?: string;
+    toolbarColor?: string;
+    toolbarActiveBackground?: string;
+    borderColor?: string;
+    borderRadius?: string;
+    selectionColor?: string;
+}
+/** Built-in toolbar item identifiers. Consumers may also register custom items. */
+type ToolbarItemId = 'undo' | 'redo' | 'separator' | 'paragraphStyle' | 'fontFamily' | 'fontSize' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'superscript' | 'subscript' | 'code' | 'textColor' | 'highlight' | 'clearFormatting' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'alignJustify' | 'bulletList' | 'orderedList' | 'taskList' | 'indent' | 'outdent' | 'blockquote' | 'horizontalRule' | 'link' | 'image' | 'table' | 'pageBreak' | 'importDocx';
+/**
+ * Toolbar configuration (F-10.6). `groups` defines ordered groups of item ids;
+ * built-in items can be reordered, removed, or replaced and custom items added.
+ */
+interface ToolbarConfig {
+    /** When false the toolbar is not rendered at all. */
+    enabled?: boolean;
+    /**
+     * Ordered groups of toolbar items. Each entry is an array of item ids; groups
+     * are visually separated. If omitted, a sensible default layout is used,
+     * filtered by the enabled {@link FeatureFlags}.
+     */
+    groups?: ToolbarItemId[][];
+    /** Sticky-position the toolbar at the top of the editor. Default true. */
+    sticky?: boolean;
+}
+/** Injectable, localizable UI strings (F-10.8, NF-6). */
+interface EditorStrings {
+    bold: string;
+    italic: string;
+    underline: string;
+    strikethrough: string;
+    superscript: string;
+    subscript: string;
+    code: string;
+    textColor: string;
+    highlight: string;
+    clearFormatting: string;
+    fontFamily: string;
+    fontSize: string;
+    paragraphStyle: string;
+    paragraph: string;
+    heading: string;
+    alignLeft: string;
+    alignCenter: string;
+    alignRight: string;
+    alignJustify: string;
+    bulletList: string;
+    orderedList: string;
+    taskList: string;
+    indent: string;
+    outdent: string;
+    blockquote: string;
+    horizontalRule: string;
+    link: string;
+    linkPrompt: string;
+    removeLink: string;
+    image: string;
+    imagePrompt: string;
+    imageAltPrompt: string;
+    table: string;
+    insertTable: string;
+    addRowBefore: string;
+    addRowAfter: string;
+    deleteRow: string;
+    addColumnBefore: string;
+    addColumnAfter: string;
+    deleteColumn: string;
+    mergeCells: string;
+    splitCell: string;
+    deleteTable: string;
+    pageBreak: string;
+    importDocx: string;
+    undo: string;
+    redo: string;
+    words: string;
+    characters: string;
+    readOnly: string;
+}
+/** Sync/save status surfaced to the host (F-9.4, NF-10). */
+type SaveStatus = 'idle' | 'savingLocal' | 'savedLocal' | 'syncing' | 'synced' | 'syncFailed' | 'offline';
+
+export type { DocumentJSON as D, EditorMode as E, FeatureFlags as F, PageConfig as P, SaveStatus as S, ThemeTokens as T, EditorStrings as a, PageSize as b, ToolbarConfig as c, ToolbarItemId as d, PageFooterElement as e, PageRunningElement as f };

package/dist/types-B4z0Quvv.d.ts

@@ -0,0 +1,193 @@
+/**
+ * Public configuration types for the editor.
+ *
+ * The entire editor is driven by a single, documented configuration object
+ * (F-10.1). Every field is optional; sensible defaults are applied by
+ * {@link resolveConfig}. Feature flags (F-10.2), page setup, theming (F-10.5),
+ * localized strings (F-10.8) and injectable adapters (F-10.12) are all expressed
+ * here so an integration can enable only what it needs without forking.
+ */
+/** ProseMirror document JSON. Kept structural so consumers don't import PM types. */
+type DocumentJSON = {
+    type: string;
+    content?: DocumentJSON[];
+    attrs?: Record<string, unknown>;
+    marks?: Array<{
+        type: string;
+        attrs?: Record<string, unknown>;
+    }>;
+    text?: string;
+};
+/** The editing surface mode (F-10.3). `comment`/`suggest` are reserved for future use. */
+type EditorMode = 'edit' | 'readonly';
+/**
+ * Individually toggleable features (F-10.2). Omitted flags fall back to
+ * {@link DEFAULT_FEATURES}. Disabling a feature removes its schema nodes/marks,
+ * commands, input rules and toolbar items together.
+ */
+interface FeatureFlags {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strikethrough: boolean;
+    superscript: boolean;
+    subscript: boolean;
+    code: boolean;
+    fontFamily: boolean;
+    fontSize: boolean;
+    textColor: boolean;
+    highlight: boolean;
+    clearFormatting: boolean;
+    headings: boolean;
+    alignment: boolean;
+    lineSpacing: boolean;
+    indentation: boolean;
+    bulletList: boolean;
+    orderedList: boolean;
+    taskList: boolean;
+    blockquote: boolean;
+    horizontalRule: boolean;
+    table: boolean;
+    image: boolean;
+    link: boolean;
+    pageBreak: boolean;
+    history: boolean;
+    wordCount: boolean;
+    docxImport: boolean;
+}
+/** Standard page sizes plus a custom escape hatch. */
+type PageSize = 'A4' | 'Letter' | 'Legal' | 'A5' | 'custom';
+/** Page geometry, in millimetres unless `size` is `custom` with explicit dimensions. */
+interface PageConfig {
+    size: PageSize;
+    /** Used only when `size === 'custom'`. Width in mm. */
+    widthMm?: number;
+    /** Used only when `size === 'custom'`. Height in mm. */
+    heightMm?: number;
+    orientation: 'portrait' | 'landscape';
+    margins: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    /** Show the page as a white sheet on a canvas background (single-flow model). */
+    showPageChrome: boolean;
+    /**
+     * Pagination model (§10.1). `'none'` (default) is the document-styled single
+     * flow; `'visual'` splits content across discrete on-screen page sheets with
+     * repeating headers/footers and live page numbers (F-5.3–F-5.5).
+     */
+    pagination?: 'none' | 'visual';
+    /** Repeating page header (visual pagination only). */
+    header?: PageRunningElement;
+    /** Repeating page footer (visual pagination only). */
+    footer?: PageFooterElement;
+}
+/** A repeating page header/footer element (visual pagination). */
+interface PageRunningElement {
+    show?: boolean;
+    /** Static text; `{page}` and `{pages}` are replaced with the live numbers. */
+    text?: string;
+    align?: 'left' | 'center' | 'right';
+}
+/** A repeating page footer, optionally showing automatic page numbers (F-5.5). */
+interface PageFooterElement extends PageRunningElement {
+    /** Show "Page X of Y" automatically when no explicit `text` is given. */
+    pageNumbers?: boolean;
+}
+/**
+ * Design tokens exposed as CSS custom properties (F-10.5). Any subset can be
+ * supplied; unspecified tokens inherit the stylesheet defaults. Consumers theme
+ * the editor without editing component source.
+ */
+interface ThemeTokens {
+    fontFamily?: string;
+    fontSize?: string;
+    textColor?: string;
+    background?: string;
+    canvasBackground?: string;
+    pageBackground?: string;
+    accent?: string;
+    toolbarBackground?: string;
+    toolbarColor?: string;
+    toolbarActiveBackground?: string;
+    borderColor?: string;
+    borderRadius?: string;
+    selectionColor?: string;
+}
+/** Built-in toolbar item identifiers. Consumers may also register custom items. */
+type ToolbarItemId = 'undo' | 'redo' | 'separator' | 'paragraphStyle' | 'fontFamily' | 'fontSize' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'superscript' | 'subscript' | 'code' | 'textColor' | 'highlight' | 'clearFormatting' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'alignJustify' | 'bulletList' | 'orderedList' | 'taskList' | 'indent' | 'outdent' | 'blockquote' | 'horizontalRule' | 'link' | 'image' | 'table' | 'pageBreak' | 'importDocx';
+/**
+ * Toolbar configuration (F-10.6). `groups` defines ordered groups of item ids;
+ * built-in items can be reordered, removed, or replaced and custom items added.
+ */
+interface ToolbarConfig {
+    /** When false the toolbar is not rendered at all. */
+    enabled?: boolean;
+    /**
+     * Ordered groups of toolbar items. Each entry is an array of item ids; groups
+     * are visually separated. If omitted, a sensible default layout is used,
+     * filtered by the enabled {@link FeatureFlags}.
+     */
+    groups?: ToolbarItemId[][];
+    /** Sticky-position the toolbar at the top of the editor. Default true. */
+    sticky?: boolean;
+}
+/** Injectable, localizable UI strings (F-10.8, NF-6). */
+interface EditorStrings {
+    bold: string;
+    italic: string;
+    underline: string;
+    strikethrough: string;
+    superscript: string;
+    subscript: string;
+    code: string;
+    textColor: string;
+    highlight: string;
+    clearFormatting: string;
+    fontFamily: string;
+    fontSize: string;
+    paragraphStyle: string;
+    paragraph: string;
+    heading: string;
+    alignLeft: string;
+    alignCenter: string;
+    alignRight: string;
+    alignJustify: string;
+    bulletList: string;
+    orderedList: string;
+    taskList: string;
+    indent: string;
+    outdent: string;
+    blockquote: string;
+    horizontalRule: string;
+    link: string;
+    linkPrompt: string;
+    removeLink: string;
+    image: string;
+    imagePrompt: string;
+    imageAltPrompt: string;
+    table: string;
+    insertTable: string;
+    addRowBefore: string;
+    addRowAfter: string;
+    deleteRow: string;
+    addColumnBefore: string;
+    addColumnAfter: string;
+    deleteColumn: string;
+    mergeCells: string;
+    splitCell: string;
+    deleteTable: string;
+    pageBreak: string;
+    importDocx: string;
+    undo: string;
+    redo: string;
+    words: string;
+    characters: string;
+    readOnly: string;
+}
+/** Sync/save status surfaced to the host (F-9.4, NF-10). */
+type SaveStatus = 'idle' | 'savingLocal' | 'savedLocal' | 'syncing' | 'synced' | 'syncFailed' | 'offline';
+
+export type { DocumentJSON as D, EditorMode as E, FeatureFlags as F, PageConfig as P, SaveStatus as S, ThemeTokens as T, EditorStrings as a, PageSize as b, ToolbarConfig as c, ToolbarItemId as d, PageFooterElement as e, PageRunningElement as f };

package/package.json

@@ -0,0 +1,183 @@
+{
+  "name": "react-next-editor-js",
+  "version": "0.1.0",
+  "description": "A comprehensive, performant, secure, configurable and pluggable Word-style rich document editor for React/Next.js, built directly on ProseMirror, with DOCX/PDF/text export and offline-first persistence.",
+  "license": "MIT",
+  "author": "stellarx57",
+  "homepage": "https://github.com/stellarx57/react-next-editor#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stellarx57/react-next-editor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stellarx57/react-next-editor/issues"
+  },
+  "type": "module",
+  "sideEffects": [
+    "*.css"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./core": {
+      "import": {
+        "types": "./dist/core/index.d.ts",
+        "default": "./dist/core/index.js"
+      },
+      "require": {
+        "types": "./dist/core/index.d.cts",
+        "default": "./dist/core/index.cjs"
+      }
+    },
+    "./export": {
+      "import": {
+        "types": "./dist/export/index.d.ts",
+        "default": "./dist/export/index.js"
+      },
+      "require": {
+        "types": "./dist/export/index.d.cts",
+        "default": "./dist/export/index.cjs"
+      }
+    },
+    "./persistence": {
+      "import": {
+        "types": "./dist/persistence/index.d.ts",
+        "default": "./dist/persistence/index.js"
+      },
+      "require": {
+        "types": "./dist/persistence/index.d.cts",
+        "default": "./dist/persistence/index.cjs"
+      }
+    },
+    "./server": {
+      "import": {
+        "types": "./dist/server/index.d.ts",
+        "default": "./dist/server/index.js"
+      },
+      "require": {
+        "types": "./dist/server/index.d.cts",
+        "default": "./dist/server/index.cjs"
+      }
+    },
+    "./import": {
+      "import": {
+        "types": "./dist/import/index.d.ts",
+        "default": "./dist/import/index.js"
+      },
+      "require": {
+        "types": "./dist/import/index.d.cts",
+        "default": "./dist/import/index.cjs"
+      }
+    },
+    "./styles.css": "./dist/styles.css",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint \"src/**/*.{ts,tsx}\"",
+    "lint:fix": "eslint \"src/**/*.{ts,tsx}\" --fix",
+    "format": "prettier --write \"src/**/*.{ts,tsx,css}\"",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "verify": "npm run type-check && npm run lint && npm run test",
+    "prepack": "npm run build",
+    "prepublishOnly": "npm run verify"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  },
+  "peerDependencies": {
+    "react": "^18.2.0 || ^19.0.0",
+    "react-dom": "^18.2.0 || ^19.0.0",
+    "docx": "^9.0.0",
+    "mammoth": "^1.0.0",
+    "playwright": "^1.0.0",
+    "puppeteer": "^22.0.0"
+  },
+  "peerDependenciesMeta": {
+    "docx": {
+      "optional": true
+    },
+    "mammoth": {
+      "optional": true
+    },
+    "playwright": {
+      "optional": true
+    },
+    "puppeteer": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "dompurify": "^3.2.4",
+    "idb": "^8.0.2",
+    "prosemirror-commands": "^1.6.2",
+    "prosemirror-dropcursor": "^1.8.1",
+    "prosemirror-gapcursor": "^1.3.2",
+    "prosemirror-history": "^1.4.1",
+    "prosemirror-inputrules": "^1.4.0",
+    "prosemirror-keymap": "^1.2.2",
+    "prosemirror-model": "^1.24.1",
+    "prosemirror-schema-list": "^1.5.0",
+    "prosemirror-state": "^1.4.3",
+    "prosemirror-tables": "^1.6.4",
+    "prosemirror-transform": "^1.10.2",
+    "prosemirror-view": "^1.37.1"
+  },
+  "devDependencies": {
+    "@testing-library/dom": "^10.4.0",
+    "@testing-library/react": "^16.1.0",
+    "@types/dompurify": "^3.0.5",
+    "@types/node": "^22.10.2",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.18.0",
+    "@typescript-eslint/parser": "^8.18.0",
+    "docx": "^9.0.0",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "jsdom": "^25.0.1",
+    "mammoth": "^1.12.0",
+    "prettier": "^3.4.2",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": ">=18.17.0"
+  },
+  "keywords": [
+    "prosemirror",
+    "editor",
+    "rich-text",
+    "word-processor",
+    "wysiwyg",
+    "docx",
+    "pdf",
+    "react",
+    "nextjs",
+    "offline-first"
+  ]
+}