@coco-vexel/coco-office-oojson 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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

@@ -1,3 +1,100 @@
-# Temporary Holding Version
+# @coco-vexel/coco-office-oojson
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+ONLYOFFICE-shaped JSON ↔ Word OOXML / Flat OPC conversion, plus PPT content/deck adapters. This is a conversion library, not an ONLYOFFICE server, editor or Excel JSON converter.
+
+## Install and runtime
+
+After the initial npm release: `npm install @coco-vexel/coco-office-oojson`.
+
+ESM JavaScript for Node.js and browser bundlers. It depends on `@coco-vexel/coco-office`. The initial release has no TypeScript declaration files or CommonJS entry. `@coco-vexel/coco-office-oojson/browser-global` ships an IIFE exposing `oojson` for a script host; it is not an ESM API entry. No Office application is required for pure conversion.
+
+```js
+import { jsonToOoxml, ooxmlToJson, jsonToFlatOpc } from '@coco-vexel/coco-office-oojson';
+const document = {
+  type: 'document',
+  content: [
+    {
+      type: 'paragraph',
+      pPr: {},
+      content: [{ type: 'run', rPr: {}, content: ['Hello'] }],
+    },
+  ],
+};
+const xml = jsonToOoxml(document);
+const { doc, gaps } = ooxmlToJson(xml);
+const flatOpc = jsonToFlatOpc(document);
+```
+
+## Create a DOCX and inspect writeback diagnostics
+
+If you directly import Core as in this example, declare it in your application too:
+
+```bash
+npm install @coco-vexel/coco-office-oojson @coco-vexel/coco-office
+```
+
+Save the following as `convert.mjs`, then run `node convert.mjs` with Node.js 22 or 24. It needs no input file and writes `converted.docx`. The exclusive write flag prevents overwriting an existing file. Browser bundlers can use the same conversion calls, replacing Node file I/O with Blob downloads.
+
+```js
+import { writeFile } from 'node:fs/promises';
+import {
+  jsonToFlatOpc,
+  jsonToOoxml,
+  ooxmlToJson,
+  flatOpcToOnlyOfficeWriteback,
+} from '@coco-vexel/coco-office-oojson';
+import { fromFlatOpc, toZip } from '@coco-vexel/coco-office/pack';
+
+const input = {
+  type: 'document',
+  content: [
+    {
+      type: 'paragraph',
+      pPr: {},
+      content: [{ type: 'run', rPr: {}, content: ['Hello OOJSON'] }],
+    },
+  ],
+};
+const { doc, gaps } = ooxmlToJson(jsonToOoxml(input));
+if (gaps.size) throw new Error(`Unmapped XML: ${JSON.stringify(gaps.top())}`);
+const flatOpc = jsonToFlatOpc(input);
+const result = flatOpcToOnlyOfficeWriteback(flatOpc);
+if (result.diagnostics.unsupportedDomains.length) {
+  throw new Error(`Unsupported writeback: ${JSON.stringify(result.diagnostics.unsupportedItems)}`);
+}
+console.log('Returned document:', doc);
+console.log('Writeback warnings:', result.diagnostics.warnings);
+await writeFile('converted.docx', await toZip(fromFlatOpc(flatOpc)), { flag: 'wx' });
+```
+
+`jsonToOoxml()` returns a Word `document.xml` string; it does not return ZIP bytes. `jsonToFlatOpc()` returns an XML package string. `toZip(fromFlatOpc(...))` creates DOCX bytes. `ooxmlToJson()` returns `{ doc, gaps }`, not the document directly. JSON conversion and writeback planning are synchronous; ZIP I/O is asynchronous.
+
+`flatOpcToOnlyOfficeWriteback()` prepares a body plus gap information and diagnostics; it does not mutate a live editor. A separate host adapter must apply these using the correct ONLYOFFICE host APIs and report failures. `gaps.size === 0` is not proof that every unsupported package feature can be written back; inspect both conversion gaps and writeback diagnostics.
+
+For a script-tag host, copy the installed `dist/oojson.global.js` to your static assets and load it with `<script src="/assets/oojson.global.js"></script>`; functions are available on `globalThis.oojson`. Do not expect named ESM exports from the `/browser-global` entry. Host scripts and DOM access remain your application's responsibility.
+
+## API groups and limits
+
+- Word body: `jsonToOoxml`, `ooxmlToJson`, `Gaps`; paragraphs, runs, tables and supported formatting. Private extension data preserves otherwise unmapped JSON fields where implemented; this does not guarantee arbitrary DOCX fidelity.
+- Word package: `jsonToFlatOpc`, `jsonToFlatOpcWithStyles`, `buildStylesXml`, `buildNumberingXml`, default theme/font/settings parts and `withPackageLongTailParts`.
+- Writeback preparation: `flatOpcToOnlyOfficeWriteback` returns `bodyJson`, `gaps` and `diagnostics` (`warnings`, `unsupportedDomains`, `unsupportedItems`). A host adapter must apply the body and check diagnostics; the library does not call ONLYOFFICE APIs itself.
+- PPT: ONLYOFFICE text content ↔ Core text bodies; deck ↔ Core models; supported text/style/model updates. Advanced geometry, charts, animations and layout are not covered by a blanket fidelity claim.
+- Long-tail limits include complex drawings/wrapping, threaded comments, picture bullets and theme effects. See [implementation notes](https://github.com/coco-vexel/coco-office/blob/main/packages/oojson/TODO.md).
+
+## Runnable verification
+
+From the repository root after install/build:
+
+```bash
+node examples/oojson-roundtrip.mjs
+corepack pnpm --filter @coco-vexel/coco-office-oojson test:portable
+corepack pnpm demo
+```
+
+Open `/oojson.html` from the demo URL for a synthetic text conversion and round-trip check. The Node example also crosses Core Flat OPC/ZIP and writeback boundaries. Neither requires DocumentBuilder or a private corpus.
+
+Optional host fidelity checks use `DOCBUILDER_EXE` and `test:ooxml`; a live ONLYOFFICE editor and its external adapter are needed to validate actual ToJSON/FromJSON execution. These are not prerequisites for installing this npm package.
+
+Apache-2.0; see LICENSE and THIRD_PARTY_NOTICES.md. Core is a separate runtime dependency; its attribution is also included for the bundled browser-global artifact.
+
+Report reproducible conversion issues with package version, synthetic input JSON and diagnostics at [GitHub Issues](https://github.com/coco-vexel/coco-office/issues). Do not attach customer files or account metadata.