@tycoworks/tycoslide 0.17.4 → 0.18.0

package/LICENSE-APACHE

@@ -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,6 +1,27 @@
-# tycoslide
+<p align="center">
+  <img src="https://raw.githubusercontent.com/tycoworks/tycoslide/main/.github/assets/logo.svg" width="96" alt="">
+</p>
 
-Create editable PowerPoint slides from markdown, using your existing .pptx templates.
+<h1 align="center">tycoslide</h1>
+
+<p align="center">Create editable PowerPoint slides from markdown, using your existing .pptx templates.</p>
+
+<p align="center">
+  <a href="https://github.com/tycoworks/tycoslide/actions/workflows/ci.yml"><img src="https://github.com/tycoworks/tycoslide/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="https://www.npmjs.com/package/@tycoworks/tycoslide"><img src="https://img.shields.io/npm/v/@tycoworks/tycoslide" alt="npm version"></a>
+  <a href="https://github.com/tycoworks/tycoslide#licence"><img src="https://img.shields.io/badge/licence-MIT%20or%20Apache%202.0-blue" alt="Licence: MIT or Apache 2.0"></a>
+</p>
+
+tycoslide creates slides from markdown using your existing .pptx templates, so you can keep your decks in Git. Like [Marp](https://marp.app) or [Slidev](https://sli.dev), but with editable output.
+
+## Features
+
+- **Paragraphs, bullets and numbered lists**, with bold, italic and links
+- **Tables, images and speaker notes**
+- **Code**, with [Shiki](https://shiki.style) syntax highlighting
+- **[Mermaid](https://mermaid.js.org) diagrams**
+
+Full syntax in [markdown.md](docs/markdown.md).
 
 ## Getting started
 
@@ -22,15 +43,6 @@ npx tycoslide build how-it-works.md
 
 https://github.com/user-attachments/assets/f31c11d8-3fe6-464f-8f02-56645b4ce3a6
 
-## Markdown support
-
-- Paragraphs, bullets and numbered lists, with bold, italic and links
-- Tables, images and speaker notes
-- Code, with [Shiki](https://shiki.style) syntax highlighting
-- [Mermaid](https://mermaid.js.org) diagrams
-
-Full syntax in [markdown.md](docs/markdown.md).
-
 ## Requirements
 
 Node 24 or later. Mermaid diagrams need Chrome on the machine; tycoslide finds an installed one, or run `npx playwright install chromium-headless-shell`.
@@ -38,3 +50,7 @@ Node 24 or later. Mermaid diagrams need Chrome on the machine; tycoslide finds a
 ## Thanks
 
 tycoslide was inspired by [pptx-automizer](https://github.com/singerla/pptx-automizer), which it uses under the hood, and by [Slidev](https://sli.dev)'s way of writing slides in markdown. You can read more about the project's background [here](https://blog.tycoworks.com/p/marketing-collateral-from-source-files).
+
+## Licence
+
+Dual-licensed under [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE), at your option.

package/dist/engine/generate.js

@@ -28,7 +28,6 @@
  */
 import { existsSync, rmSync } from "node:fs";
 import { basename, dirname, resolve } from "node:path";
-import { DOMParser, XMLSerializer } from "@xmldom/xmldom";
 import { Automizer, modify } from "pptx-automizer";
 import { FILLERS } from "./fillers/filler.js";
 import { isImageFill } from "./fillers/image.js";
@@ -309,54 +308,36 @@ function applyBlock(slide, sourceAlias, baseSlide, slot, block, callbacks) {
     if (baseBlock && baseBlock.shapeName !== block.shapeName)
         slide.removeElement(baseBlock.shapeName);
 }
-// ── Notes archive adapter (automizer-buffer glue) ────────────────────────────
-/** Installed pptx-automizer version this notes-buffer adapter is pinned to. */
-const PPTX_AUTOMIZER_VERSION = "0.8.2";
 /**
- * Bridge pptx-automizer's OUTPUT archive (`parent.targetArchive`) to the minimal
- * {@link NotesArchive} surface, cooperating with automizer's XML buffer.
+ * Bridge pptx-automizer's OUTPUT archive to the minimal {@link NotesArchive}
+ * surface.
  *
- * automizer caches every part it edits via `readXml`/`writeXml` — for a cloned
+ * automizer keeps every part it edits via `readXml`/`writeXml` — for a cloned
  * slide's notes that means `slide{N}.xml.rels`, `notesSlide{N}.xml.rels`, and
- * `[Content_Types].xml` — as a parsed document, then re-serializes the cache over
- * the zip at write() time. A plain `write`/`remove` to those parts is therefore
- * silently reverted at the final flush. This adapter reads the buffered
- * (automizer-current) content and steers writes/removes back through the same
- * buffer, so `applyNotesToSlide` stays pure over string+xmldom while its edits
- * survive. The notes PART (`notesSlide{N}.xml`) is copied raw and never buffered,
- * so it round-trips as a plain zip entry. The buffer holds docs parsed by the one
- * installed `@xmldom/xmldom`, so our parser/serializer operate on them safely.
+ * `[Content_Types].xml` — as a parsed document, and writes those documents over
+ * the zip at write() time, so a plain `write`/`remove` of such a part would be
+ * silently reverted. Each call therefore flushes the part first: `flushXml`
+ * writes automizer's current document to the zip and drops it, so the plain zip
+ * operation that follows sees the current content and its result is final. If
+ * automizer reads the part again, it re-parses what this wrote.
  */
 function toNotesArchive(target) {
-    // Fail loud if automizer's internals no longer expose the buffer array this
-    // adapter steers writes through: without it, every buffered write would be
-    // silently reverted at the final flush, corrupting the deck with no error.
-    if (!Array.isArray(target.buffer)) {
-        throw new Error("Speaker notes: expected the pptx-automizer archive to expose a `buffer` array " +
-            `(pinned to pptx-automizer ${PPTX_AUTOMIZER_VERSION}); its internals may have changed. ` +
-            "Re-verify the notes buffer adapter before relying on it.");
-    }
-    const buffer = target.buffer;
-    const buffered = (file) => buffer.find((entry) => entry.relativePath === file);
     return {
         async read(file, type) {
-            const entry = buffered(file);
-            return entry ? new XMLSerializer().serializeToString(entry.content) : target.read(file, type);
+            await target.flushXml(file);
+            return target.read(file, type);
         },
         async write(file, data) {
-            const entry = buffered(file);
-            if (entry)
-                entry.content = new DOMParser().parseFromString(data, "application/xml");
+            await target.flushXml(file);
             return target.write(file, data);
         },
         async remove(file) {
-            const index = buffer.findIndex((entry) => entry.relativePath === file);
-            if (index !== -1)
-                buffer.splice(index, 1);
+            await target.flushXml(file);
             await target.remove(file);
         },
-        fileExists(file) {
-            return buffered(file) !== undefined || target.fileExists(file);
+        async fileExists(file) {
+            await target.flushXml(file);
+            return target.fileExists(file);
         },
         async folder(dir) {
             return target.folder(dir);

package/dist/engine/notes.d.ts

@@ -14,17 +14,17 @@
  * are excluded) — so the designer's template notes never leak into the output.
  */
 /**
- * The minimal archive surface `applyNotesToSlide` needs. pptx-automizer's
- * `IArchive` satisfies it structurally (so we never import its internal type), and
- * the test fake implements it over a `Map`. String-based `read`/`write` only —
- * XML is parsed/serialized with the engine's own `@xmldom/xmldom` instance, never
+ * The minimal archive surface `applyNotesToSlide` needs. `toNotesArchive` in
+ * `generate.ts` builds it over pptx-automizer's output archive, and the test fake
+ * implements it over a `Map`. String-based `read`/`write` only — XML is
+ * parsed/serialized with the engine's own `@xmldom/xmldom` instance, never
  * automizer's `readXml`/`writeXml` (mixing xmldom instances risks subtle bugs).
  */
 export type NotesArchive = {
     read(file: string, type: "string"): Promise<string | Buffer>;
     write(file: string, data: string): Promise<unknown>;
     remove(file: string): Promise<void>;
-    fileExists(file: string): boolean;
+    fileExists(file: string): Promise<boolean>;
     /**
      * Top-level entries of `dir` (nested `_rels` excluded). `name` is the FULL
      * archive path (e.g. `ppt/notesSlides/notesSlide1.xml`). pptx-automizer's

package/dist/engine/notes.js

@@ -104,7 +104,7 @@ function notesRelsXml(slideNumber, masterTarget) {
  * the presentation declares no notes master relationship.
  */
 async function findNotesMaster(archive) {
-    if (!archive.fileExists(PRESENTATION_RELS_PART))
+    if (!(await archive.fileExists(PRESENTATION_RELS_PART)))
         return undefined;
     const master = readRelationships(await readString(archive, PRESENTATION_RELS_PART)).find((rel) => rel.type.endsWith(RelTypeSuffix.NotesMaster));
     return master && `../${master.target}`;
@@ -193,7 +193,7 @@ export async function sweepOrphanNotes(archive) {
     const referenced = new Set();
     for (const slidePart of await liveSlideParts(archive)) {
         const relsPath = relsPathFor(slidePart);
-        if (!archive.fileExists(relsPath))
+        if (!(await archive.fileExists(relsPath)))
             continue;
         for (const rel of readRelationships(await readString(archive, relsPath))) {
             if (rel.type.endsWith(RelTypeSuffix.NotesSlide))
@@ -208,7 +208,7 @@ export async function sweepOrphanNotes(archive) {
     for (const part of orphans) {
         await archive.remove(part);
         const relsPart = `ppt/notesSlides/_rels/${part.slice(part.lastIndexOf("/") + 1)}.rels`;
-        if (archive.fileExists(relsPart))
+        if (await archive.fileExists(relsPart))
             await archive.remove(relsPart);
         if (removeOverrideFromDoc(ctDoc, `/${part}`))
             ctChanged = true;
@@ -237,7 +237,7 @@ export async function applyNotesToSlide(archive, slideNumber, notes, excludeNote
     const notesPath = `ppt/notesSlides/notesSlide${slideNumber}.xml`;
     const notesRelsPath = `ppt/notesSlides/_rels/notesSlide${slideNumber}.xml.rels`;
     const slideRelsPath = `ppt/slides/_rels/slide${slideNumber}.xml.rels`;
-    const notesExists = archive.fileExists(notesPath);
+    const notesExists = await archive.fileExists(notesPath);
     const shouldWrite = notes !== undefined && notes !== "" && !excludeNotes;
     if (shouldWrite) {
         if (notesExists) {
@@ -262,7 +262,7 @@ export async function applyNotesToSlide(archive, slideNumber, notes, excludeNote
     if (!notesExists)
         return;
     await archive.remove(notesPath);
-    if (archive.fileExists(notesRelsPath))
+    if (await archive.fileExists(notesRelsPath))
         await archive.remove(notesRelsPath);
     const relsDoc = parseXml(await readString(archive, slideRelsPath));
     if (removeNotesRel(relsDoc))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tycoworks/tycoslide",
-  "version": "0.17.4",
+  "version": "0.18.0",
   "description": "Create editable PowerPoint slides from markdown, using your existing .pptx templates.",
   "author": "tycoworks",
   "homepage": "https://github.com/tycoworks/tycoslide",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/tycoworks/tycoslide.git"
   },
   "bugs": "https://github.com/tycoworks/tycoslide/issues",
-  "license": "MIT",
+  "license": "MIT OR Apache-2.0",
   "keywords": [
     "markdown",
     "powerpoint",
@@ -30,7 +30,9 @@
     "dist",
     "bin",
     "docs",
-    "theme-package"
+    "theme-package",
+    "LICENSE-MIT",
+    "LICENSE-APACHE"
   ],
   "engines": {
     "node": ">=24"
@@ -48,9 +50,9 @@
     "commander": "^15.0.0",
     "image-size": "^2.0.4",
     "jszip": "^3.10.1",
-    "mermaid": "^11.16.1",
+    "mermaid": "^12.3.0",
     "playwright-core": "^1.62.1",
-    "pptx-automizer": "^0.8.2",
+    "pptx-automizer": "^0.9.4",
     "remark-gfm": "^4.0.1",
     "remark-ins": "^1.2.5",
     "remark-parse": "^11.0.0",
@@ -62,6 +64,6 @@
   "devDependencies": {
     "@biomejs/biome": "^2.5.1",
     "@types/node": "^24.19.2",
-    "typescript": "^5.8.0"
+    "typescript": "^7.0.2"
   }
 }