@coco-vexel/coco-office 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,121 @@
-# Temporary Holding Version
+# @coco-vexel/coco-office
 
-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.
+Read, query, modify and export Word (`.docx`), Excel (`.xlsx`) and PowerPoint (`.pptx`) documents in JavaScript. Core supplies document/package APIs; it does not render a full Office application or call Office host APIs.
+
+## Installation and requirements
+
+```bash
+npm install @coco-vexel/coco-office
+```
+
+These instructions target the initial npm release; availability is subject to publication. Use Node.js 22 or 24 for the examples below, saved as `.mjs` files. ESM, CommonJS and TypeScript declarations are included. Browser applications should use a bundler and supply file selection/download handling. Neither Microsoft Office nor a backend is required for local document operations.
+
+## Quick start: create a Word document
+
+Save as `word.mjs`, then run `node word.mjs`. No input document is required. It creates `hello.docx` in the current directory; `wx` prevents overwriting an existing file.
+
+```js
+import { writeFile } from 'node:fs/promises';
+import { WordDocument } from '@coco-vexel/coco-office/word';
+
+const doc = await WordDocument.createBlank({ docId: 'hello', mode: 'inline' });
+try {
+  const { paragraphs } = await doc.paragraphs.list({ pagination: { mode: 'all' } });
+  await paragraphs[0].replaceWith('Hello from Coco Office');
+  await writeFile('hello.docx', await doc.toZip(), { flag: 'wx' });
+} finally {
+  await doc.dispose();
+}
+```
+
+For an existing DOCX, use `WordDocument.fromZip(await readFile(inputPath), { docId: 'edit', mode: 'inline' })`. Write the returned bytes to a separate output path. `paragraphs.list()` supports pagination; request `pagination: { mode: 'all' }` when the operation needs all paragraphs.
+
+## Edit an Excel workbook
+
+Save as `excel.mjs`; run `node excel.mjs input.xlsx Sheet1`. The named sheet must already exist. This writes `edited.xlsx` and leaves the input file unchanged. The example writes a literal value, not a formula.
+
+```js
+import { readFile, writeFile } from 'node:fs/promises';
+import { ExcelWorkbook } from '@coco-vexel/coco-office/excel';
+
+const [, , inputPath, sheetName = 'Sheet1'] = process.argv;
+if (!inputPath) throw new Error('Usage: node excel.mjs input.xlsx [sheetName]');
+const book = await ExcelWorkbook.fromZip(await readFile(inputPath), {
+  workbookId: 'example',
+  mode: 'inline',
+});
+try {
+  await book.worksheets
+    .getItem(sheetName)
+    .getRange('B2')
+    .setValues([[42]]);
+  await writeFile('edited.xlsx', await book.toZip(), { flag: 'wx' });
+} finally {
+  await book.dispose();
+}
+```
+
+## Edit a PowerPoint text shape
+
+Save as `ppt.mjs`; run `node ppt.mjs input.pptx Title`. The first slide must contain a text shape with the supplied name. This produces `edited.pptx`; it does not render slide images.
+
+```js
+import { readFile, writeFile } from 'node:fs/promises';
+import { Presentation } from '@coco-vexel/coco-office/ppt';
+
+const [, , inputPath, shapeName = 'Title'] = process.argv;
+if (!inputPath) throw new Error('Usage: node ppt.mjs input.pptx [shapeName]');
+const deck = await Presentation.fromZip(await readFile(inputPath));
+try {
+  await deck.slides.getItem(0).shapes.getItem(shapeName).text.setText('Updated title');
+  await writeFile('edited.pptx', await deck.toZip(), { flag: 'wx' });
+} finally {
+  await deck.dispose();
+}
+```
+
+## Public entrypoints
+
+| Import                                                            | Purpose                                                      |
+| ----------------------------------------------------------------- | ------------------------------------------------------------ |
+| `@coco-vexel/coco-office/pack`                                    | OOXML ZIP/Flat OPC package I/O                               |
+| `@coco-vexel/coco-office/word`                                    | Word document, paragraphs/ranges and supported edits         |
+| `@coco-vexel/coco-office/word-view`                               | Word projection/index helpers for views                      |
+| `@coco-vexel/coco-office/excel`                                   | Worksheets, cells/ranges, formula subset and workbook export |
+| `@coco-vexel/coco-office/ppt`                                     | Slides, text/shapes/tables and presentation export           |
+| `@coco-vexel/coco-office/shared`                                  | Shared utilities                                             |
+| `@coco-vexel/coco-office/kernel-worker`, `/kernel-worker-browser` | Word Node/browser worker bootstraps                          |
+| `@coco-vexel/coco-office/excel-worker`, `/excel-worker-browser`   | Excel Node/browser worker bootstraps                         |
+
+ESM example: `import { WordDocument } from '@coco-vexel/coco-office/word'`.
+CommonJS example: `const { WordDocument } = require('@coco-vexel/coco-office/word')`.
+Use domain entrypoints for the APIs you need; do not import `src/` or undocumented `dist/` paths.
+
+## Lifecycle, browser use and limitations
+
+Call `dispose()` in `finally`, including when an edit/export fails. The examples use inline mode, which requires no Worker setup. Node Worker mode requires `WordDocument.setWorkerBundleUrl(...)` or `ExcelWorkbook.setWorkerBundleUrl(...)`; browser Workers require the corresponding browser factory. Do not load Node Worker bootstraps as browser entrypoints. Inline mode can block the UI for large documents; profile representative files before choosing a worker configuration.
+
+In a browser, read `new Uint8Array(await file.arrayBuffer())` and pass it to `fromZip`. Download output with a Blob/object URL; loading and saving files are application responsibilities. To display/edit documents visually, use `@coco-vexel/coco-office-editor`.
+
+Word layout, Excel formulas/rich objects, and PPT advanced objects/animations have feature-specific limits. Unknown-part preservation and export/reparse tests do not guarantee all edits are supported or pixel-identical rendering in Office. A missing sheet/shape, malformed input or unsupported operation should be handled by the caller; never discard the original file after an unchecked export.
+
+## Documentation
+
+| Area       | Start here                                                                                                | Detailed reference                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
+| ---------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| General    | [Getting started](https://github.com/coco-vexel/coco-office/blob/main/docs/core/getting-started.md)       | [API index](https://github.com/coco-vexel/coco-office/blob/main/docs/core/api-reference.md) and [cookbook](https://github.com/coco-vexel/coco-office/blob/main/docs/core/cookbook.md)                                                                                                                                                                                                                                                                                                       |
+| Word       | [Word documentation](https://github.com/coco-vexel/coco-office/blob/main/docs/core/README.md)             | [Paragraphs](https://github.com/coco-vexel/coco-office/blob/main/docs/core/domains/paragraphs.md), [ranges](https://github.com/coco-vexel/coco-office/blob/main/docs/core/domains/ranges.md), [tables](https://github.com/coco-vexel/coco-office/blob/main/docs/core/domains/tables.md), [comments](https://github.com/coco-vexel/coco-office/blob/main/docs/core/domains/comments.md), and [revisions](https://github.com/coco-vexel/coco-office/blob/main/docs/core/domains/revisions.md) |
+| Excel      | [Excel documentation](https://github.com/coco-vexel/coco-office/blob/main/docs/core/excel/README.md)      | [API reference](https://github.com/coco-vexel/coco-office/blob/main/docs/core/excel/api-reference.md) and [formula support](https://github.com/coco-vexel/coco-office/blob/main/docs/core/excel/formula-support.md)                                                                                                                                                                                                                                                                         |
+| PowerPoint | [PowerPoint documentation](https://github.com/coco-vexel/coco-office/blob/main/docs/core/ppt/README.md)   | [API reference](https://github.com/coco-vexel/coco-office/blob/main/docs/core/ppt/api-reference.md) and [style capabilities](https://github.com/coco-vexel/coco-office/blob/main/docs/core/ppt/style-capabilities.md)                                                                                                                                                                                                                                                                       |
+| Runtime    | [Runtime, tests and demos](https://github.com/coco-vexel/coco-office/blob/main/docs/runtime-and-demos.md) | [Runtime modes](https://github.com/coco-vexel/coco-office/blob/main/docs/core/advanced/runtime.md) and [host integration](https://github.com/coco-vexel/coco-office/blob/main/docs/core/advanced/host-integration.md)                                                                                                                                                                                                                                                                       |
+
+GitHub Releases also provide a self-contained SDK bundle with this package,
+offline documentation and runnable Word/Excel/PowerPoint examples.
+
+## Runnable repository demo
+
+For synthetic three-format fixtures and round-trip assertions, clone the repository, run `corepack pnpm install --frozen-lockfile`, `corepack pnpm build`, then `corepack pnpm example`. These are repository commands, not scripts shipped with the installed npm package.
+
+Report reproducible SDK issues with package version and a minimal synthetic document at [GitHub Issues](https://github.com/coco-vexel/coco-office/issues). Follow [SECURITY.md](https://github.com/coco-vexel/coco-office/blob/main/SECURITY.md) for private vulnerability reports.
+
+Apache-2.0 for original code; see LICENSE and THIRD_PARTY_NOTICES.md in the package.