@ifc-lite/bcf 1.18.1 → 2.0.0

package/dist/xml-text.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Reading text back out of BCF's XML.
+ *
+ * Split out of `reader.ts` so the component parsers can share it without a
+ * cycle. `writer.ts::escapeXml` is the inverse of `unescapeXml` here, and the
+ * two are pinned against each other in `writer.test.ts`.
+ */
+/**
+ * Extract a simple element value from XML
+ *
+ * Values are unescaped so writer.ts's escapeXml() round-trips correctly
+ * (see escapeXml/unescapeXml regression: & < > " ' in titles/descriptions/
+ * comments must come back exactly as written, not as literal entities).
+ */
+export declare function extractElement(content: string, elementName: string): string | undefined;
+/**
+ * Decode XML character references: the five named entities `escapeXml` writes,
+ * and the numeric forms `&#38;` / `&#x26;` that other authoring tools emit.
+ *
+ * ONE pass, not a chain of `replace` calls. A chain has to decode `&amp;` last,
+ * or a literal `&lt;` written as `&amp;lt;` is corrupted into `<` by the
+ * earlier pass -- and adding numeric references to a chain reintroduces that
+ * hazard from a second direction, since `&#38;lt;` decodes to `&lt;` and would
+ * then be re-scanned. A single pass never looks at its own output, so the
+ * ordering question does not arise at all.
+ *
+ * An unrecognised or out-of-range reference is returned untouched rather than
+ * dropped: this reads other tools' archives, and losing a character is worse
+ * than leaving one encoded.
+ */
+export declare function unescapeXml(str: string): string;
+//# sourceMappingURL=xml-text.d.ts.map

package/dist/xml-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xml-text.d.ts","sourceRoot":"","sources":["../src/xml-text.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AAEH;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAGvF;AAWD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAW/C"}

package/dist/xml-text.js

@@ -0,0 +1,55 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+/**
+ * Reading text back out of BCF's XML.
+ *
+ * Split out of `reader.ts` so the component parsers can share it without a
+ * cycle. `writer.ts::escapeXml` is the inverse of `unescapeXml` here, and the
+ * two are pinned against each other in `writer.test.ts`.
+ */
+/**
+ * Extract a simple element value from XML
+ *
+ * Values are unescaped so writer.ts's escapeXml() round-trips correctly
+ * (see escapeXml/unescapeXml regression: & < > " ' in titles/descriptions/
+ * comments must come back exactly as written, not as literal entities).
+ */
+export function extractElement(content, elementName) {
+    const match = content.match(new RegExp(`<${elementName}>([^<]*)<\\/${elementName}>`));
+    return match?.[1] !== undefined ? unescapeXml(match[1]) : undefined;
+}
+/** The five entities `writer.ts::escapeXml` produces. */
+const NAMED_ENTITIES = {
+    lt: '<',
+    gt: '>',
+    quot: '"',
+    apos: "'",
+    amp: '&',
+};
+/**
+ * Decode XML character references: the five named entities `escapeXml` writes,
+ * and the numeric forms `&#38;` / `&#x26;` that other authoring tools emit.
+ *
+ * ONE pass, not a chain of `replace` calls. A chain has to decode `&amp;` last,
+ * or a literal `&lt;` written as `&amp;lt;` is corrupted into `<` by the
+ * earlier pass -- and adding numeric references to a chain reintroduces that
+ * hazard from a second direction, since `&#38;lt;` decodes to `&lt;` and would
+ * then be re-scanned. A single pass never looks at its own output, so the
+ * ordering question does not arise at all.
+ *
+ * An unrecognised or out-of-range reference is returned untouched rather than
+ * dropped: this reads other tools' archives, and losing a character is worse
+ * than leaving one encoded.
+ */
+export function unescapeXml(str) {
+    return str.replace(/&(?:#(\d+)|#[xX]([0-9a-fA-F]+)|(lt|gt|quot|apos|amp));/g, (whole, dec, hex, name) => {
+        if (name !== undefined)
+            return NAMED_ENTITIES[name];
+        const code = Number.parseInt(dec ?? hex ?? '', dec !== undefined ? 10 : 16);
+        return Number.isFinite(code) && code >= 0 && code <= 0x10ffff
+            ? String.fromCodePoint(code)
+            : whole;
+    });
+}
+//# sourceMappingURL=xml-text.js.map

package/dist/xml-text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"xml-text.js","sourceRoot":"","sources":["../src/xml-text.ts"],"names":[],"mappings":"AAAA;;+DAE+D;AAE/D;;;;;;GAMG;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,cAAc,CAAC,OAAe,EAAE,WAAmB;IACjE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,IAAI,WAAW,eAAe,WAAW,GAAG,CAAC,CAAC,CAAC;IACtF,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACtE,CAAC;AAED,yDAAyD;AACzD,MAAM,cAAc,GAA2B;IAC7C,EAAE,EAAE,GAAG;IACP,EAAE,EAAE,GAAG;IACP,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,GAAG;IACT,GAAG,EAAE,GAAG;CACT,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,GAAG,CAAC,OAAO,CAChB,yDAAyD,EACzD,CAAC,KAAK,EAAE,GAAuB,EAAE,GAAuB,EAAE,IAAwB,EAAE,EAAE;QACpF,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,GAAG,IAAI,EAAE,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,QAAQ;YAC3D,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC;YAC5B,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ifc-lite/bcf",
-  "version": "1.18.1",
+  "version": "2.0.0",
   "description": "BIM Collaboration Format (BCF) support for IFC-Lite",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,11 +14,12 @@
   },
   "dependencies": {
     "jszip": "^3.10.0",
-    "@ifc-lite/encoding": "^2.0.0"
+    "@ifc-lite/encoding": "^2.1.0"
   },
   "devDependencies": {
     "typescript": "^6.0.3",
-    "vitest": "^4.1.10"
+    "vitest": "^4.1.10",
+    "xmllint-wasm": "5.3.0"
   },
   "license": "MPL-2.0",
   "author": "Louis True",