@portone/docx-editor 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @portone/docx-editor
+
+## 0.1.0
+
+The first release.
+
+[The documentation](https://docx-editor.portone.io/docs) covers what the editor edits, what it preserves untouched, and its current limitations.

package/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing
+
+Thank you for taking the time to improve `@portone/docx-editor`. Bug reports, documentation improvements, fixes, and focused feature proposals are welcome.
+
+<!-- This file is published to npm while the documents it points at are not, so those links are
+     absolute rather than repository-relative. -->
+
+If you use an AI coding tool, also follow the repository guidance in [AGENTS.md](https://github.com/portone-io/docx-editor/blob/main/AGENTS.md).
+
+## Reporting bugs
+
+[Open an issue](https://github.com/portone-io/docx-editor/issues/new) with enough detail to reproduce the problem. Include what you expected and what happened instead.
+
+If the problem depends on a particular DOCX file, attach a minimal example after removing confidential or identifying content.
+
+## Setup
+
+```sh
+git clone https://github.com/portone-io/docx-editor.git
+cd docx-editor
+pnpm install
+pnpm dev
+```
+
+`pnpm dev` serves the `demo/` package with `demo.docx` open and reloads it as the source changes. `pnpm build:demo` produces its static bundle.
+
+`pnpm dev:site` serves the [documentation and landing site](https://github.com/portone-io/docx-editor/blob/main/site/README.md), and `pnpm build:site` produces its build.
+
+## OOXML changes
+
+For changes that interpret or write OOXML, follow the [specification workflow](https://github.com/portone-io/docx-editor/blob/main/spec/README.md#working-with-the-specification).
+
+## Tests
+
+Run the default local checks before opening a pull request:
+
+```sh
+pnpm check
+```
+
+Run a specialized check when your change affects its area:
+
+```sh
+pnpm test:package
+pnpm verify:package
+pnpm test:e2e
+```
+
+[Testing](https://github.com/portone-io/docx-editor/blob/main/docs/testing.md) explains the scope and prerequisites of every check.
+
+## Changesets
+
+If you changed anything under `src/`, run `pnpm changeset` and commit the file it writes.
+It becomes the CHANGELOG entry, so write it for someone reading release notes rather than the diff.
+Choose `patch` unless the change adds to or breaks the public API.
+Those are `minor` while the package is below 1.0.
+
+By contributing, you agree that your contribution is licensed under the Apache License 2.0 used by this project.
+
+## Commit messages
+
+Write the package name as a code span (`@portone/docx-editor`) in commit messages, pull request bodies, and comments, and leave the scope out of pull request titles.
+Written bare, the scope reads as a mention of the unrelated GitHub user who holds that handle.

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright © 2026 PortOne Korea Corp.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,48 @@
+# @portone/docx-editor
+
+A simple DOCX editor for the browser that reads and writes OOXML directly while preserving the document structure around each edit. Edit text, formatting, lists, tables, images, links, and locked content controls without an HTML conversion step.
+
+<p align="center">
+  <img src="./assets/editor.png" alt="A DOCX document open in the editor" width="960" />
+</p>
+
+## Quick start
+
+```sh
+npm install @portone/docx-editor
+```
+
+```tsx
+import "@portone/docx-editor/styles.css";
+
+import { DocxEditor, type DocxEditorHandle } from "@portone/docx-editor";
+import { useRef } from "react";
+
+export function Editor({ file }: { file: File }) {
+  const editorRef = useRef<DocxEditorHandle | null>(null);
+
+  return <DocxEditor ref={editorRef} document={file} />;
+}
+```
+
+`document` accepts a `File`, `Blob`, `ArrayBuffer`, or `Uint8Array`; use the ref to export the edited document as bytes.
+
+## What it does
+
+- Provides browser editing with built-in controls, read-only mode, and document locking.
+- Fits the page to the available width by default and lets readers choose a fixed zoom level.
+- Exports edited documents as DOCX bytes or browser downloads.
+- Preserves document structures and package parts across edits.
+- Reads document styles, theme fonts, page layout, and CJK font information for display.
+
+See [Feature support](https://docx-editor.portone.io/docs/features) for the support matrix. Build [custom controls](https://docx-editor.portone.io/docs/custom-controls) or use [programmatic DOCX import and export](https://docx-editor.portone.io/docs/core).
+
+The full [documentation](https://docx-editor.portone.io/docs) lives on the documentation site.
+
+## Contributing
+
+Contributions are welcome; see [CONTRIBUTING.md](./CONTRIBUTING.md) to get started.
+
+## License
+
+Licensed under the [Apache License 2.0](./LICENSE).

package/dist/DocxEditor.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Renders one editing surface for a docx document, with the toolbar and the right click
+ * menus around it.
+ *
+ * It keeps a second copy of the editor state that ProseMirror holds as React state,
+ * so the buttons and the menus re-decide themselves every time the cursor moves.
+ *
+ * To swap the document, change the `key` and remount.
+ */
+import type { Plugin } from "prosemirror-state";
+import type { EditorView } from "prosemirror-view";
+import { type CSSProperties, type ReactNode } from "react";
+import { type DocxSource } from "./docx/importDocx";
+import { type CommentAuthor } from "./editor/commands/commentCommands";
+import { DocxImportError } from "./ooxml/errors";
+import type { FontFallbacks } from "./styles/fontStack";
+import type { DocxEditorPresets } from "./ui/presets";
+import { type DocxEditorZoom } from "./ui/zoom";
+export interface DocxEditorHandle {
+    view: EditorView;
+    /** Turns the editor state currently on screen into docx bytes */
+    exportBytes: () => Uint8Array;
+}
+/**
+ * What the editor is for, which decides what it offers.
+ *
+ * A read-only editor takes no edits, so it has no toolbar and no right click menus either: what
+ * used to be three booleans of which one silently emptied the other two is one choice here.
+ * `locking` is what a screen where a template is written gets: settling a part of a document is
+ * an authoring act, not something every reader of a form should be handed. A lock the document
+ * already carries holds whichever mode is chosen.
+ *
+ * `contextMenus: false` leaves the right click to the browser, for a consumer drawing menus of
+ * its own. The plugins that take the browser's menu away go into the editor state, which is built
+ * when the editor mounts, so this is read once there like `plugins`.
+ */
+export type DocxEditorMode = {
+    kind: "readOnly";
+} | {
+    kind: "edit";
+    toolbar?: boolean;
+    contextMenus?: boolean;
+    locking?: boolean;
+};
+export interface DocxEditorProps {
+    /**
+     * The document to open: the bytes, or the `File`/`Blob` a file input or a fetch
+     * hands over, which the editor reads itself.
+     *
+     * Bytes open on the spot. A `Blob` is read first, so the editor stands empty for
+     * that moment; whichever document arrived last is the one opened.
+     */
+    document: DocxSource;
+    /**
+     * What to render instead when the document could not be opened.
+     *
+     * A built-in panel naming the reason is drawn when none is given, so a refusal is
+     * never silent either way. Hand one in to write the refusal in your own words.
+     */
+    renderImportError?: (error: DocxImportError) => ReactNode;
+    /** What the editor is for. Editing with the toolbar shown and no locking when none is given */
+    mode?: DocxEditorMode;
+    /** Whether to draw approximate page boundaries over the document's own paper. Drawn when read only too */
+    showPageGuides?: boolean;
+    /**
+     * The document's visual scale. `fit-width` follows the editor's available width;
+     * a number uses that fixed scale without changing document layout or export.
+     */
+    zoom?: DocxEditorZoom;
+    /** Read once for uncontrolled state. Later changes are ignored. Defaults to `fit-width` */
+    defaultZoom?: DocxEditorZoom;
+    /** Receives toolbar requests; a controlled consumer must update `zoom` to apply one */
+    onZoomChange?: (zoom: DocxEditorZoom) => void;
+    /**
+     * The fonts drawn in place of the ones a document declares, for the names that
+     * are missing from the reader's machine.
+     * The built-in set knows the CJK and Latin office font names and lands on a
+     * Latin sans for the rest; hand in your own set to stand in different fonts.
+     * A set handed in reaches the runs and the paper, while paragraph styles and
+     * the HTML copied out keep the built-in set, which is shared beyond one editor.
+     * It only ever affects what is drawn - the exported document keeps the fonts it
+     * declared.
+     *
+     * Read once, when the editor mounts, like `plugins`. Later changes to it are
+     * ignored, so writing the set inline on every render is harmless; to change the
+     * fallbacks, change the `key` and remount.
+     */
+    fontFallbacks?: FontFallbacks;
+    /**
+     * The lists the toolbar's pickers offer: fonts, colors, font sizes, line spacings and
+     * cell borders.
+     * Every list left out is the built-in one. A font or a size the open document itself
+     * uses is offered whether or not the list handed in holds it.
+     *
+     * Read on every render, unlike `fontFallbacks` and `plugins`, so a list built from state
+     * takes effect without a remount.
+     */
+    presets?: DocxEditorPresets;
+    /** The identity written by the built-in comment and reply composers */
+    commentAuthor?: CommentAuthor;
+    /**
+     * ProseMirror plugins handed in by the consumer, which is how mentions, highlights,
+     * autocomplete and the like are added from outside the package.
+     * They are placed ahead of the built-in plugins, so a consumer keymap or DOM handler
+     * sees an event first and can override a built-in shortcut.
+     * A read-only editor gets them too.
+     *
+     * Read once, when the editor mounts. Later changes to this array are ignored, so
+     * building it inline on every render is harmless; to swap the plugins, change the
+     * `key` and remount.
+     */
+    plugins?: readonly Plugin[];
+    className?: string;
+    style?: CSSProperties;
+    onReady?: (view: EditorView) => void;
+    /** Called every time the editor state changes. This covers cursor and selection moves, not just text edits */
+    onChange?: () => void;
+}
+/**
+ * `forwardRef` rather than a `ref` prop: React 18 hands a function component no `ref`
+ * in its props, so the handle would never be built there.
+ */
+export declare const DocxEditor: import("react").ForwardRefExoticComponent<DocxEditorProps & import("react").RefAttributes<DocxEditorHandle | null>>;