@pptx-studio/writer 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# @pptx-studio/writer
+
+## 0.1.0
+
+### Minor Changes
+
+- 7d905f4: First release.
+
+  `@pptx-studio/render-svg` turns a slide into an SVG string, and `pptx-studio render`
+  does it from the command line with no browser and no LibreOffice — text included,
+  measured out of the font's own tables. The other nine packages are what those two
+  are built on and are published because they have to be, not because their surface
+  is settled.
+
+  Everything here is pre-1.0 and the API will change. What will not change without a
+  very good reason is what the writer does to a package it was not asked to edit: a
+  part nobody touched is re-emitted byte for byte, across all 54 decks in the corpus.
+
+### Patch Changes
+
+- Updated dependencies [7d905f4]
+  - @pptx-studio/opc@0.1.0
+  - @pptx-studio/validate@0.1.0
+  - @pptx-studio/xml@0.1.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 2026 Dewiride Technologies
+
+   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/NOTICE

@@ -0,0 +1,43 @@
+PPTX Studio
+Copyright 2026 Dewiride Technologies
+
+This product includes software developed at Dewiride Technologies
+(https://github.com/Dewiride-Open-Source/Dewiride-PPTX-Studio).
+
+--------------------------------------------------------------------------------
+Third-party material redistributed in this repository
+--------------------------------------------------------------------------------
+
+Entries are added here at the moment the material lands, not at release time.
+
+  * Apache POI
+      Copyright The Apache Software Foundation
+      Licensed under the Apache License, Version 2.0.
+      https://poi.apache.org/
+
+    @pptx-studio/geometry contains the 187 DrawingML preset shape definitions,
+    transcoded at build time from POI's presetShapeDefinitions.xml by
+    tools/geometry-codegen. The transcoded form is a re-encoding of that file's
+    content and carries POI's copyright.
+
+    The file itself is not redistributed in this repository. The generated
+    modules in packages/geometry/src/presets record the SHA-256 of the exact
+    input they were produced from:
+
+      presetShapeDefinitions.xml, 538970 bytes
+      sha256 4a762444d8d85876881c02a5b1dedf6f73006fcd8acb7b4e393435615b37c780
+
+--------------------------------------------------------------------------------
+Attributions the plan commits us to, listed so the obligation is visible before
+the code arrives
+--------------------------------------------------------------------------------
+
+  * Pattern fill tiles (sub-phase 2.7) are generated from Mono libgdiplus.
+      libgdiplus - Copyright Novell, Inc. and contributors - MIT
+
+  * Metric-compatible substitute fonts ship in a separate package,
+    @pptx-studio/fonts-metric-compat, under SIL OFL 1.1 with its own
+    OFL.txt and reserved-font-name handling. They are deliberately kept out
+    of this Apache-2.0 tree so the licence boundary is a package boundary.
+
+See LEGAL.md for the clean-room record and the reimplementation basis.

package/README.md

@@ -0,0 +1,184 @@
+# @pptx-studio/writer
+
+**Handing the file back.** A part nobody edited is never serialized — its stored
+DEFLATE stream is copied from the source archive to the output archive without
+ever being inflated. Charts, SmartArt, animations, OLE objects and macros
+survive because nothing had to understand them.
+
+Apache-2.0 · browser and Web Worker only, no Node · part of
+[PPTX Studio](https://github.com/Dewiride-Open-Source/Dewiride-PPTX-Studio).
+
+```ts
+import { exportPackage, openPackage } from '@pptx-studio/writer';
+
+const pkg = openPackage(bytes); // { store, baseline, baselineBytes }
+pkg.store.replacePart('/ppt/slides/slide1.xml', edited);
+
+const { bytes: out, rewritten, streamed } = exportPackage(pkg);
+// rewritten: ['/ppt/slides/slide1.xml']  -- everything else streamed
+```
+
+`exportPackage` throws rather than returning bytes that would make PowerPoint
+show a repair prompt.
+
+## Why the writer is not allowed to understand the document
+
+A writer that emits a `.pptx` from a model can only emit the features that model
+has. Every feature it has not been taught is a feature the file loses on save —
+which is why a deck that goes through most browser editors comes out without its
+charts, its SmartArt, its animations and its macros. Not because anyone decided
+to drop them, but because the export path had no way to write them and no way to
+notice.
+
+Preservation cannot be a feature with a coverage percentage. The percentage is
+never a hundred, and the missing part is always somebody's.
+
+So it is the default state instead: parts are opaque bytes, and only the ones
+something explicitly replaced are re-encoded.
+
+## What happens on an export, and in what order
+
+| Step               | Why it is there                                                  |
+| ------------------ | ---------------------------------------------------------------- |
+| `prepare` hooks    | Save-time work owned by other packages — font embedding, autofit |
+| Media collection   | Runs after the hooks, because a hook is what orphans things      |
+| `PartStore.write`  | Untouched parts stream through still compressed                  |
+| Preservation check | The emitted archive against the source archive, entry by entry   |
+| `assertValid`      | The 29 rules; refuses to return the bytes if we broke one        |
+
+The two checks come **after** the write, which is the one ordering that looks
+backwards. It is right because a check that runs first is checking an intention,
+and what a user opens is an archive. Bytes are produced, then judged, then either
+returned or thrown away — never returned unjudged.
+
+## Media garbage collection
+
+Off in effect unless something was actually orphaned, and deliberately timid
+about what it will touch.
+
+**The sweep set is `/ppt/media/`.** Not layouts, not masters, not
+`ppt/embeddings/*.bin`, whatever the relationship graph says about them.
+PowerPoint keeps slide layouts no slide uses — that is how the layout picker has
+anything to offer — and a package where an unused layout has been tidied away is
+one where "change layout" has quietly lost options. The layout is kilobytes; the
+media is the megabytes.
+
+**The walk is rooted at the package, not at the slide list.** The obvious
+implementation asks "which images do the slides use?" and it is wrong in a way
+that shows up weeks later: a layout no slide currently uses still has its
+background picture, and switching a slide onto it has to still work.
+
+**By default it only collects what this session orphaned**, by differencing
+reachability against the baseline. A deck can arrive with an orphaned image, and
+collecting it would mean that merely opening and saving a file changes it.
+
+**It cannot break a relationship.** A part is collected only when nothing in the
+package resolves to it, so there is no edge left to dangle — and two slides
+sharing one image, one of them deleted, cannot lose it, because the surviving
+relationship still marks it live. The corollary is that the sweep is a safety
+net and not a delete: removing the picture's `r:embed` is part of deleting the
+picture, and that is the command layer's job.
+
+```ts
+// Everything unreferenced, however it got that way. Refuses if the graph
+// could not be walked completely — an unreadable edge is an invisible edge.
+collectGarbage({ store, policy: 'every-orphan' });
+```
+
+## Prepare hooks
+
+Several later phases owe the file something at save time, and none of it is this
+package's subject: embedded fonts are six artifacts that must all be present or
+PowerPoint reports a problem; autofit has to write back `@fontScale`; the
+`p14:media` / `a:videoFile` relationship pair is a duplicate on the way out.
+
+```ts
+exportPackage({ ...pkg, prepare: [embedFonts, commitAutofit] });
+```
+
+Hooks run in the order given, before collection and before validation. Before
+collection because a hook is exactly the thing that changes what is referenced;
+before validation because a hook writes markup, and newly synthesized markup is
+the riskiest kind there is. One that throws stops the export — five of the six
+font artifacts written is a package PowerPoint refuses with no way to find out
+which.
+
+## The baseline is not optional in practice
+
+`openPackage` hands back the package and an untouched twin. Leaving the twin out
+costs three things: the three preservation rules are skipped rather than passed,
+the media sweep collects nothing because there is no way to tell what this
+session orphaned, and every fatal finding counts as one we introduced — so the
+firewall gets _stricter_, not quieter.
+
+## Is it still the same deck?
+
+`comparePackages` answers it, and `roundTripPackage` does the whole thing —
+open, export, compare — in one call. `pptx-studio roundtrip` is a thin front end
+over it.
+
+```ts
+const { ok, comparison } = roundTripPackage(bytes);
+// comparison.differences: [] · counts: { xml, binary, relationships, same }
+```
+
+**Not by comparing bytes.** Entry order, deflate level, timestamps and attribute
+order differ legitimately between two archives holding one document — nine of
+the corpus's PowerPoint-authored decks come out exactly 1832 bytes smaller with
+every stored byte of every entry identical, because Office writes a `0xA220`
+growth-hint extra field on five entries and we do not.
+
+`assertPreserved` above and this are not competing. That one asks whether the
+entries we promised not to touch came out identical, which is the right question
+for a no-op export and the only question it can answer. This one asks whether a
+package we _edited_, or one somebody else wrote, is the same document.
+
+Three comparisons, one per kind of content:
+
+- **XML parts** by canonical form — `canonicalXml` in `@pptx-studio/xml`, which
+  sorts attributes and normalises escaping but keeps prefixes, unused namespace
+  declarations and every space, because in OOXML those are meaning.
+- **Relationship parts** as a graph with the ids treated as opaque labels,
+  matched by what they resolve to. The mapping is then applied to the referring
+  markup, so a deck PowerPoint re-saved — renumbering every `rId` — compares
+  equal, while two `r:embed` values that swapped targets do not.
+- **Everything else** by SHA-256. Not `crc32`: a 32-bit code collides within
+  about 2^16 inputs, which is fewer parts than the corpus has.
+
+`[Content_Types].xml` is compared as neither. It is a map with several spellings,
+so what is compared is the resolved content type of every part.
+
+## Which of those differences is the one that matters?
+
+`bisectPackages` answers it, and `pptx-studio bisect` is the front end.
+`comparePackages` above says _that_ two packages differ and where; this narrows a
+delta of hundreds down to the changes that are actually load-bearing.
+
+```ts
+const { minimal, bytes, runs } = bisectPackages(original, broken, { oracle });
+// minimal: [{ entry: '[Content_Types].xml', kind: 'children', where: '/Types/Default[3]', … }]
+// bytes:   the smallest package that still fails — ready to open, or to keep
+```
+
+It is Zeller's `ddmin` over the **set of changes** between the two packages,
+applied level by level down the tree (Misherghi and Su's HDD). Isolation rather
+than simplification, and the difference is not academic: because a configuration
+is a subset of changes applied to the original, and the splice unit is a whole
+node replaced by a whole node, **every candidate is well-formed XML by
+construction** — no oracle run is ever spent on markup no editor could produce.
+
+The delta is taken over **ZIP entries, not parts**, because `[Content_Types].xml`
+is not a part, and a missing `<Default Extension="fntdata"/>` in it is the
+canonical repair prompt. Anything that parses as XML is descended into; anything
+else is one atom.
+
+The oracle is yours: `(bytes) => 'fails' | 'passes' | 'unresolved'`. The third
+value is Zeller's too and it earns its place — a timed-out PowerPoint read as
+"passes" would let the reducer discard the guilty change and blame an innocent
+one.
+
+## What is not here
+
+The CI round-trip gate and the badge are 1.6. And no bisection has yet been
+driven by a failure nobody planted — which is the good news about 1.3 and 1.4,
+and also the reason this is untested against the case it was built for.