@langeditor/plugin-docx 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present TyCoding and LangEditor contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/PRD.md

@@ -0,0 +1,20 @@
+# DOCX Plugin PRD
+
+## Boundary
+
+`@langeditor/plugin-docx` owns DOCX import, DOCX export, Word image handling,
+and DOCX fallback registration. Core owns the editor, Word page layout, and
+comment model but does not load DOCX runtimes.
+
+## Runtime behavior
+
+- Package import registers per-editor `ImportWord` and `ExportWord` extensions.
+- DOCX parsing and serialization use dynamic imports from the command handlers.
+- The package is usable through Vue, Web Components, and the React adapter because
+  the extensions are ordinary Tiptap extensions.
+- Import failures, file-size failures, and unsupported structures remain
+  localized through the core locale and diagnostics APIs.
+
+## License
+
+MIT. No commercial license feature is required.

package/README.md

@@ -0,0 +1,57 @@
+# @langeditor/plugin-docx
+
+DOCX import and export for LangEditor. The plugin keeps `docx`,
+`prosemirror-docx`, and the DOCX parser out of the core editor bundle. Importing
+the package registers the extensions with the editor plugin runtime; the parser
+and serializer are still loaded only when the corresponding command is used.
+
+## Install
+
+```bash
+pnpm add @langeditor/core @langeditor/plugin-docx
+```
+
+```ts
+import '@langeditor/plugin-docx'
+import { BaseKit, LangEditor } from '@langeditor/core'
+```
+
+With the side-effect registration enabled, `LangEditor` adds the Word actions
+automatically. To configure image uploads or export image resolution, pass
+plugin options through `pluginOptions`:
+
+```vue
+<LangEditor
+  v-model="content"
+  :plugin-options="{
+    docx: {
+      importWord: { upload: uploadImages },
+      exportWord: { resolveImage: resolveImage },
+    },
+  }"
+/>
+```
+
+The extensions and serializers are also available for explicit composition:
+
+```ts
+import {
+  ExportWord,
+  ImportWord,
+  createDocxDocument,
+  parseDocx,
+} from '@langeditor/plugin-docx'
+
+const extensions = [
+  ImportWord.configure({ spacer: true }),
+  ExportWord,
+]
+```
+
+`ImportWord` preserves supported text, headings, lists, tables, links, images,
+and Word comments. Unsupported structures produce diagnostics instead of being
+silently dropped. `ExportWord` serializes ordinary editor content and Word page
+documents, including comments and registered fallback representations.
+
+The plugin is MIT licensed. It requires `@langeditor/core >=1.1.0 <2.0.0` and
+does not add any commercial capability or license requirement.