ooxml-core 1.20.0 → 1.22.0

package/dist/opc/index.cjs

@@ -138,6 +138,19 @@ var DEFAULT_XML_LIMITS = {
   maxDepth: 512,
   maxNodes: 5e6
 };
+var XmlLimitError = class extends Error {
+  code = "xml-limit";
+  /** The limit that was exceeded. */
+  limit;
+  /** Its value: the largest depth or element count allowed. */
+  maximum;
+  constructor(message, limit, maximum) {
+    super(message);
+    this.name = "XmlLimitError";
+    this.limit = limit;
+    this.maximum = maximum;
+  }
+};
 var TAG_RE = /<(\/?)([^\s\/><]+)(?:\s+[^\s=\/><]+\s*=\s*(?:"[^"<]*"|'[^'<]*'))*\s*(\/?)>/y;
 var MARKUP_SKIPS = [
   ["<!--", "-->"],
@@ -171,11 +184,22 @@ function checkXmlLimits(xml, label, limits = {}) {
       continue;
     }
     nodes++;
-    if (nodes > maxNodes) throw new Error(`${label} XML exceeds the limit of ${maxNodes} elements`);
+    if (nodes > maxNodes)
+      throw new XmlLimitError(
+        `${label} XML exceeds the limit of ${maxNodes} elements`,
+        "maxNodes",
+        maxNodes
+      );
     if (!selfClosing && ++depth > maxDepth)
-      throw new Error(`${label} XML exceeds the nesting depth limit of ${maxDepth}`);
+      throw new XmlLimitError(
+        `${label} XML exceeds the nesting depth limit of ${maxDepth}`,
+        "maxDepth",
+        maxDepth
+      );
   }
 }
+var CRLF_DECLARATION = /^<\?xml[^>]*\?>\r\n/;
+var crlfDeclarations = /* @__PURE__ */ new WeakSet();
 function parseXml(xml, options = {}) {
   const label = options.label ?? "OOXML";
   if (/<!DOCTYPE|<!ENTITY/i.test(xml))
@@ -197,9 +221,13 @@ function parseXml(xml, options = {}) {
   }
   if (parseError || !parsed.documentElement)
     throw new Error(`Invalid ${label} XML: ${parseError || "missing root element"}`);
+  if (CRLF_DECLARATION.test(xml)) crlfDeclarations.add(parsed);
   return parsed;
 }
-var buildXml = (node) => new xmldom.XMLSerializer().serializeToString(node);
+var buildXml = (node) => {
+  const xml = new xmldom.XMLSerializer().serializeToString(node);
+  return crlfDeclarations.has(node) ? xml.replace(/^(<\?xml[^>]*\?>)\n/, "$1\r\n") : xml;
+};
 var isElement = (node) => node.nodeType === 1;
 var elements = (parent) => Array.from(parent.childNodes).filter(isElement);
 function named(element, local, ns, lenient = true) {
@@ -465,10 +493,13 @@ var DEFAULT_ZIP_LIMITS = {
 var ZipLimitError = class extends Error {
   code = "ZIP_BOMB";
   limit;
+  /** The check that failed (absent when the error was built without one). */
+  kind;
   constructor(message, details) {
     super(message);
     this.name = "ZipLimitError";
     this.limit = details.limit;
+    this.kind = details.kind;
   }
 };
 var mib = (bytes) => Math.round(bytes / 1048576);
@@ -491,7 +522,7 @@ function resolveLimits(limits) {
     maxEntryBytes: limits.maxEntryBytes ?? DEFAULT_ZIP_LIMITS.maxEntryBytes,
     maxTotalBytes: limits.maxTotalBytes ?? DEFAULT_ZIP_LIMITS.maxTotalBytes,
     label: limits.label ?? "ZIP",
-    fail: (message, limit) => create ? create(message, { limit }) : new ZipLimitError(message, { limit })
+    fail: (message, limit, kind) => create ? create(message, { limit, kind }) : new ZipLimitError(message, { limit, kind })
   };
 }
 function inflateEntryGuarded(entry, alreadyRead, limits) {
@@ -514,13 +545,18 @@ function inflateEntryGuarded(entry, alreadyRead, limits) {
       size += chunk.byteLength;
       if (size > declared || size > r.maxEntryBytes)
         return abort(
-          r.fail(`${r.label} part ${entry.name} inflates past its declared size`, r.maxEntryBytes)
+          r.fail(
+            `${r.label} part ${entry.name} inflates past its declared size`,
+            r.maxEntryBytes,
+            size > declared ? "declaredSize" : "maxEntryBytes"
+          )
         );
       if (alreadyRead + size > r.maxTotalBytes)
         return abort(
           r.fail(
             `${r.label} package exceeds the ${mib(r.maxTotalBytes)} MiB uncompressed content limit`,
-            r.maxTotalBytes
+            r.maxTotalBytes,
+            "maxTotalBytes"
           )
         );
       chunks.push(chunk);
@@ -553,26 +589,29 @@ function guardZip(zip, limits = {}) {
   if (entries.length > r.maxEntries)
     throw r.fail(
       `${r.label} package exceeds the ${r.maxEntries.toLocaleString("en-US")} part limit`,
-      r.maxEntries
+      r.maxEntries,
+      "maxEntries"
     );
   let declared = 0;
   for (const entry of entries) {
     const original = entry.unsafeOriginalName;
     if (!isSafePartName(entry.name) || original !== void 0 && !isSafePartName(original))
-      throw r.fail(`${r.label} package has an unsafe part name`, r.maxEntries);
+      throw r.fail(`${r.label} package has an unsafe part name`, r.maxEntries, "partName");
     if (entry.dir) continue;
     const size = declaredEntrySize(entry);
     if (size > r.maxEntryBytes)
       throw r.fail(
         `${r.label} part ${entry.name} exceeds the uncompressed part size limit`,
-        r.maxEntryBytes
+        r.maxEntryBytes,
+        "maxEntryBytes"
       );
     declared += size;
   }
   if (declared > r.maxTotalBytes)
     throw r.fail(
       `${r.label} package exceeds the ${mib(r.maxTotalBytes)} MiB uncompressed content limit`,
-      r.maxTotalBytes
+      r.maxTotalBytes,
+      "maxTotalBytes"
     );
   const produced = /* @__PURE__ */ new Map();
   let total = 0;
@@ -610,7 +649,8 @@ async function openZip(input, limits = {}) {
   if (bytes.byteLength > maxInput)
     throw r.fail(
       `${r.label} package exceeds the ${mib(maxInput)} MiB compressed input limit`,
-      maxInput
+      maxInput,
+      "maxInputBytes"
     );
   return guardZip(await JSZip__default.default.loadAsync(bytes), limits);
 }

package/dist/opc/index.mjs

@@ -132,6 +132,19 @@ var DEFAULT_XML_LIMITS = {
   maxDepth: 512,
   maxNodes: 5e6
 };
+var XmlLimitError = class extends Error {
+  code = "xml-limit";
+  /** The limit that was exceeded. */
+  limit;
+  /** Its value: the largest depth or element count allowed. */
+  maximum;
+  constructor(message, limit, maximum) {
+    super(message);
+    this.name = "XmlLimitError";
+    this.limit = limit;
+    this.maximum = maximum;
+  }
+};
 var TAG_RE = /<(\/?)([^\s\/><]+)(?:\s+[^\s=\/><]+\s*=\s*(?:"[^"<]*"|'[^'<]*'))*\s*(\/?)>/y;
 var MARKUP_SKIPS = [
   ["<!--", "-->"],
@@ -165,11 +178,22 @@ function checkXmlLimits(xml, label, limits = {}) {
       continue;
     }
     nodes++;
-    if (nodes > maxNodes) throw new Error(`${label} XML exceeds the limit of ${maxNodes} elements`);
+    if (nodes > maxNodes)
+      throw new XmlLimitError(
+        `${label} XML exceeds the limit of ${maxNodes} elements`,
+        "maxNodes",
+        maxNodes
+      );
     if (!selfClosing && ++depth > maxDepth)
-      throw new Error(`${label} XML exceeds the nesting depth limit of ${maxDepth}`);
+      throw new XmlLimitError(
+        `${label} XML exceeds the nesting depth limit of ${maxDepth}`,
+        "maxDepth",
+        maxDepth
+      );
   }
 }
+var CRLF_DECLARATION = /^<\?xml[^>]*\?>\r\n/;
+var crlfDeclarations = /* @__PURE__ */ new WeakSet();
 function parseXml(xml, options = {}) {
   const label = options.label ?? "OOXML";
   if (/<!DOCTYPE|<!ENTITY/i.test(xml))
@@ -191,9 +215,13 @@ function parseXml(xml, options = {}) {
   }
   if (parseError || !parsed.documentElement)
     throw new Error(`Invalid ${label} XML: ${parseError || "missing root element"}`);
+  if (CRLF_DECLARATION.test(xml)) crlfDeclarations.add(parsed);
   return parsed;
 }
-var buildXml = (node) => new XMLSerializer().serializeToString(node);
+var buildXml = (node) => {
+  const xml = new XMLSerializer().serializeToString(node);
+  return crlfDeclarations.has(node) ? xml.replace(/^(<\?xml[^>]*\?>)\n/, "$1\r\n") : xml;
+};
 var isElement = (node) => node.nodeType === 1;
 var elements = (parent) => Array.from(parent.childNodes).filter(isElement);
 function named(element, local, ns, lenient = true) {
@@ -459,10 +487,13 @@ var DEFAULT_ZIP_LIMITS = {
 var ZipLimitError = class extends Error {
   code = "ZIP_BOMB";
   limit;
+  /** The check that failed (absent when the error was built without one). */
+  kind;
   constructor(message, details) {
     super(message);
     this.name = "ZipLimitError";
     this.limit = details.limit;
+    this.kind = details.kind;
   }
 };
 var mib = (bytes) => Math.round(bytes / 1048576);
@@ -485,7 +516,7 @@ function resolveLimits(limits) {
     maxEntryBytes: limits.maxEntryBytes ?? DEFAULT_ZIP_LIMITS.maxEntryBytes,
     maxTotalBytes: limits.maxTotalBytes ?? DEFAULT_ZIP_LIMITS.maxTotalBytes,
     label: limits.label ?? "ZIP",
-    fail: (message, limit) => create ? create(message, { limit }) : new ZipLimitError(message, { limit })
+    fail: (message, limit, kind) => create ? create(message, { limit, kind }) : new ZipLimitError(message, { limit, kind })
   };
 }
 function inflateEntryGuarded(entry, alreadyRead, limits) {
@@ -508,13 +539,18 @@ function inflateEntryGuarded(entry, alreadyRead, limits) {
       size += chunk.byteLength;
       if (size > declared || size > r.maxEntryBytes)
         return abort(
-          r.fail(`${r.label} part ${entry.name} inflates past its declared size`, r.maxEntryBytes)
+          r.fail(
+            `${r.label} part ${entry.name} inflates past its declared size`,
+            r.maxEntryBytes,
+            size > declared ? "declaredSize" : "maxEntryBytes"
+          )
         );
       if (alreadyRead + size > r.maxTotalBytes)
         return abort(
           r.fail(
             `${r.label} package exceeds the ${mib(r.maxTotalBytes)} MiB uncompressed content limit`,
-            r.maxTotalBytes
+            r.maxTotalBytes,
+            "maxTotalBytes"
           )
         );
       chunks.push(chunk);
@@ -547,26 +583,29 @@ function guardZip(zip, limits = {}) {
   if (entries.length > r.maxEntries)
     throw r.fail(
       `${r.label} package exceeds the ${r.maxEntries.toLocaleString("en-US")} part limit`,
-      r.maxEntries
+      r.maxEntries,
+      "maxEntries"
     );
   let declared = 0;
   for (const entry of entries) {
     const original = entry.unsafeOriginalName;
     if (!isSafePartName(entry.name) || original !== void 0 && !isSafePartName(original))
-      throw r.fail(`${r.label} package has an unsafe part name`, r.maxEntries);
+      throw r.fail(`${r.label} package has an unsafe part name`, r.maxEntries, "partName");
     if (entry.dir) continue;
     const size = declaredEntrySize(entry);
     if (size > r.maxEntryBytes)
       throw r.fail(
         `${r.label} part ${entry.name} exceeds the uncompressed part size limit`,
-        r.maxEntryBytes
+        r.maxEntryBytes,
+        "maxEntryBytes"
       );
     declared += size;
   }
   if (declared > r.maxTotalBytes)
     throw r.fail(
       `${r.label} package exceeds the ${mib(r.maxTotalBytes)} MiB uncompressed content limit`,
-      r.maxTotalBytes
+      r.maxTotalBytes,
+      "maxTotalBytes"
     );
   const produced = /* @__PURE__ */ new Map();
   let total = 0;
@@ -604,7 +643,8 @@ async function openZip(input, limits = {}) {
   if (bytes.byteLength > maxInput)
     throw r.fail(
       `${r.label} package exceeds the ${mib(maxInput)} MiB compressed input limit`,
-      maxInput
+      maxInput,
+      "maxInputBytes"
     );
   return guardZip(await JSZip.loadAsync(bytes), limits);
 }

package/dist/opc/zip-folders.d.ts

@@ -0,0 +1,11 @@
+import type JSZip from 'jszip';
+/** The entry names of a package, taken when it is opened, before anything is written to it. */
+export declare const entryNames: (zip: JSZip) => ReadonlySet<string>;
+/**
+ * Removes the folder entries JSZip adds for the parent folders of each file it writes (its
+ * `createFolders` default) unless the package had them when it was opened (`source`, from
+ * {@link entryNames}). Office writes no folder entries, so a saved package keeps the shape of its
+ * source instead of gaining a `word/` or `xl/` entry on every save.
+ */
+export declare function dropAddedFolders(zip: JSZip, source: ReadonlySet<string>): void;
+//# sourceMappingURL=zip-folders.d.ts.map

package/dist/opc/zip-folders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip-folders.d.ts","sourceRoot":"","sources":["../../opc/zip-folders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,+FAA+F;AAC/F,eAAO,MAAM,UAAU,QAAS,KAAK,KAAG,WAAW,CAAC,MAAM,CAAoC,CAAC;AAE/F;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,GAAG,IAAI,CAG9E"}

package/dist/opc/zip-limits.d.ts

@@ -6,6 +6,11 @@ export declare const DEFAULT_ZIP_LIMITS: {
     readonly maxEntryBytes: number;
     readonly maxTotalBytes: number;
 };
+/**
+ * The check a package failed: one of the {@link ZipLimits} sizes, `declaredSize` (an entry
+ * inflates past the size its header declares) or `partName` (an unsafe part name).
+ */
+export type ZipLimitKind = 'maxInputBytes' | 'maxEntries' | 'maxEntryBytes' | 'maxTotalBytes' | 'declaredSize' | 'partName';
 /** Size and hygiene limits applied while opening and reading a zip package. */
 export interface ZipLimits {
     /** Largest accepted package (compressed bytes). */
@@ -21,14 +26,18 @@ export interface ZipLimits {
     /** Builds the error thrown on a violation; defaults to {@link ZipLimitError}. */
     createError?: (message: string, details: {
         limit: number;
+        kind: ZipLimitKind;
     }) => Error;
 }
 /** Thrown when a package breaks a size, entry-count or part-name limit. */
 export declare class ZipLimitError extends Error {
     readonly code = "ZIP_BOMB";
     readonly limit: number;
+    /** The check that failed (absent when the error was built without one). */
+    readonly kind: ZipLimitKind | undefined;
     constructor(message: string, details: {
         limit: number;
+        kind?: ZipLimitKind;
     });
 }
 /** True when a zip entry name is a safe, relative part name (no traversal, drive or backslash). */

package/dist/opc/zip-limits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zip-limits.d.ts","sourceRoot":"","sources":["../../opc/zip-limits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,0DAA0D;AAC1D,eAAO,MAAM,kBAAkB;aAC9B,aAAa;aACb,UAAU,EAAE,KAAM;aAClB,aAAa;aACb,aAAa;CACJ,CAAC;AAEX,+EAA+E;AAC/E,MAAM,WAAW,SAAS;IACzB,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mEAAmE;IACnE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,KAAK,CAAC;CACrE;AAED,2EAA2E;AAC3E,qBAAa,aAAc,SAAQ,KAAK;IACvC,QAAQ,CAAC,IAAI,cAAc;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,EAItD;CACD;AAID,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAMpD;AAED,gFAAgF;AAChF,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,GAAG,MAAM,CAIlE;AA0BD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAClC,KAAK,EAAE,KAAK,CAAC,WAAW,EACxB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,SAAS,GACf,OAAO,CAAC,UAAU,CAAC,CA8CrB;AASD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,GAAE,SAAc,GAAG,KAAK,CA0DlE;AAED,kFAAkF;AAClF,wBAAsB,OAAO,CAC5B,KAAK,EAAE,UAAU,GAAG,WAAW,EAC/B,MAAM,GAAE,SAAc,GACpB,OAAO,CAAC,KAAK,CAAC,CAUhB"}
+{"version":3,"file":"zip-limits.d.ts","sourceRoot":"","sources":["../../opc/zip-limits.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,0DAA0D;AAC1D,eAAO,MAAM,kBAAkB;aAC9B,aAAa;aACb,UAAU,EAAE,KAAM;aAClB,aAAa;aACb,aAAa;CACJ,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,YAAY,GACrB,eAAe,GACf,YAAY,GACZ,eAAe,GACf,eAAe,GACf,cAAc,GACd,UAAU,CAAC;AAEd,+EAA+E;AAC/E,MAAM,WAAW,SAAS;IACzB,mDAAmD;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mEAAmE;IACnE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,YAAY,CAAA;KAAE,KAAK,KAAK,CAAC;CACzF;AAED,2EAA2E;AAC3E,qBAAa,aAAc,SAAQ,KAAK;IACvC,QAAQ,CAAC,IAAI,cAAc;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,SAAS,CAAC;IACxC,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,YAAY,CAAA;KAAE,EAK3E;CACD;AAID,mGAAmG;AACnG,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAMpD;AAED,gFAAgF;AAChF,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,GAAG,MAAM,CAIlE;AA0BD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAClC,KAAK,EAAE,KAAK,CAAC,WAAW,EACxB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,SAAS,GACf,OAAO,CAAC,UAAU,CAAC,CAmDrB;AASD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,GAAE,SAAc,GAAG,KAAK,CA6DlE;AAED,kFAAkF;AAClF,wBAAsB,OAAO,CAC5B,KAAK,EAAE,UAAU,GAAG,WAAW,EAC/B,MAAM,GAAE,SAAc,GACpB,OAAO,CAAC,KAAK,CAAC,CAWhB"}