@onerjs/serializers 8.41.5 → 8.41.7

package/3MF/core/model/3mf.opc.interfaces.js

@@ -0,0 +1,75 @@
+export const OpenXmlContentTypesNamespace = "http://schemas.openxmlformats.org/package/2006/content-types";
+export const OpenXmlRelationshipsNamespace = "http://schemas.openxmlformats.org/package/2006/relationships";
+export var KnownI3mfContentType;
+(function (KnownI3mfContentType) {
+    // OPC core
+    KnownI3mfContentType["Relationships"] = "application/vnd.openxmlformats-package.relationships+xml";
+    // 3MF core
+    KnownI3mfContentType["Model"] = "application/vnd.ms-package.3dmanufacturing-3dmodel+xml";
+    // Extensions officielles
+    KnownI3mfContentType["Materials"] = "application/vnd.ms-package.3dmanufacturing-material+xml";
+    KnownI3mfContentType["Colors"] = "application/vnd.ms-package.3dmanufacturing-colors+xml";
+    KnownI3mfContentType["Texture"] = "application/vnd.ms-package.3dmanufacturing-texture+xml";
+    KnownI3mfContentType["Texture2D"] = "application/vnd.ms-package.3dmanufacturing-texture2d+xml";
+    KnownI3mfContentType["Production"] = "application/vnd.ms-package.3dmanufacturing-production+xml";
+    KnownI3mfContentType["Slice"] = "application/vnd.ms-package.3dmanufacturing-slice+xml";
+    KnownI3mfContentType["BeamLattice"] = "application/vnd.ms-package.3dmanufacturing-beamlattice+xml";
+    KnownI3mfContentType["SecureContent"] = "application/vnd.ms-package.3dmanufacturing-securecontent+xml";
+    // Assets
+    KnownI3mfContentType["Png"] = "image/png";
+    KnownI3mfContentType["Jpeg"] = "image/jpeg";
+    KnownI3mfContentType["Tiff"] = "image/tiff";
+    KnownI3mfContentType["Xml"] = "application/xml";
+})(KnownI3mfContentType || (KnownI3mfContentType = {}));
+export const RelationshipDirName = "_rels/";
+export const Object3dDirName = "3D/";
+export const ModelFileName = `3dmodel.model`;
+export const RelationshipFileName = `.rels`;
+export const ContentTypeFileName = "[Content_Types].xml";
+/**
+ * Common OPC and 3MF relationship Type URIs.
+ */
+export class Known3mfRelationshipTypes {
+    /**
+     * Test if the relationship Type is one of the common known URIs above
+     * @param type
+     * @returns true if the relationship Type is one of the common known URIs above
+     */
+    static IsKnown(type) {
+        return Known3mfRelationshipTypes.Known.has(type);
+    }
+    /**
+     * test if the relationship Type is the main 3MF model entry point
+     * @param type
+     * @returns  true if the relationship Type is the main 3MF model entry point
+     */
+    static IsThreeDimModel(type) {
+        return type === Known3mfRelationshipTypes.ThreeDimModel;
+    }
+}
+/**
+ * 3MF core: points to the main .model part of the package
+ */
+Known3mfRelationshipTypes.ThreeDimModel = "http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel";
+/**
+ * OPC core: points to a package thumbnail (often used by 3MF packages)
+ */
+Known3mfRelationshipTypes.Thumbnail = "http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail";
+/**
+ * 3MF (print ticket): optional printing settings part (rarely used by slicers)
+ */
+Known3mfRelationshipTypes.PrintTicket = "http://schemas.microsoft.com/3dmanufacturing/2013/01/printticket";
+/**
+ * OPC core: indicates parts that must be preserved when editing the package
+ */
+Known3mfRelationshipTypes.MustPreserve = "http://schemas.openxmlformats.org/package/2006/relationships/mustpreserve";
+/**
+ * Convenience set for quick checks
+ */
+Known3mfRelationshipTypes.Known = new Set([
+    Known3mfRelationshipTypes.ThreeDimModel,
+    Known3mfRelationshipTypes.Thumbnail,
+    Known3mfRelationshipTypes.PrintTicket,
+    Known3mfRelationshipTypes.MustPreserve,
+]);
+//# sourceMappingURL=3mf.opc.interfaces.js.map

package/3MF/core/model/3mf.opc.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"3mf.opc.interfaces.js","sourceRoot":"","sources":["../../../../../../dev/serializers/src/3MF/core/model/3mf.opc.interfaces.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,4BAA4B,GAAG,8DAA8D,CAAC;AAC3G,MAAM,CAAC,MAAM,6BAA6B,GAAG,8DAA8D,CAAC;AAE5G,MAAM,CAAN,IAAY,oBAsBX;AAtBD,WAAY,oBAAoB;IAC5B,WAAW;IACX,kGAA0E,CAAA;IAE1E,WAAW;IACX,wFAAgE,CAAA;IAEhE,yBAAyB;IACzB,6FAAqE,CAAA;IACrE,wFAAgE,CAAA;IAChE,0FAAkE,CAAA;IAClE,8FAAsE,CAAA;IACtE,gGAAwE,CAAA;IACxE,sFAA8D,CAAA;IAC9D,kGAA0E,CAAA;IAC1E,sGAA8E,CAAA;IAE9E,SAAS;IACT,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,2CAAmB,CAAA;IACnB,+CAAuB,CAAA;AAC3B,CAAC,EAtBW,oBAAoB,KAApB,oBAAoB,QAsB/B;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG,QAAQ,CAAC;AAC5C,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAC;AACrC,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAAC;AAC7C,MAAM,CAAC,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAC5C,MAAM,CAAC,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;AAEzD;;GAEG;AACH,MAAM,OAAO,yBAAyB;IA+BlC;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,IAAY;QAC9B,OAAO,yBAAyB,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACtC,OAAO,IAAI,KAAK,yBAAyB,CAAC,aAAa,CAAC;IAC5D,CAAC;;AA9CD;;GAEG;AACoB,uCAAa,GAAG,8DAA8D,CAAC;AAEtG;;GAEG;AACoB,mCAAS,GAAG,iFAAiF,CAAC;AAErH;;GAEG;AACoB,qCAAW,GAAG,kEAAkE,CAAC;AAExG;;GAEG;AACoB,sCAAY,GAAG,2EAA2E,CAAC;AAElH;;GAEG;AACoB,+BAAK,GAAwB,IAAI,GAAG,CAAS;IAChE,yBAAyB,CAAC,aAAa;IACvC,yBAAyB,CAAC,SAAS;IACnC,yBAAyB,CAAC,WAAW;IACrC,yBAAyB,CAAC,YAAY;CACzC,CAAC,CAAC","sourcesContent":["import type { I3mfModel } from \"./3mf.interfaces\";\n\nexport const OpenXmlContentTypesNamespace = \"http://schemas.openxmlformats.org/package/2006/content-types\";\nexport const OpenXmlRelationshipsNamespace = \"http://schemas.openxmlformats.org/package/2006/relationships\";\n\nexport enum KnownI3mfContentType {\n    // OPC core\n    Relationships = \"application/vnd.openxmlformats-package.relationships+xml\",\n\n    // 3MF core\n    Model = \"application/vnd.ms-package.3dmanufacturing-3dmodel+xml\",\n\n    // Extensions officielles\n    Materials = \"application/vnd.ms-package.3dmanufacturing-material+xml\",\n    Colors = \"application/vnd.ms-package.3dmanufacturing-colors+xml\",\n    Texture = \"application/vnd.ms-package.3dmanufacturing-texture+xml\",\n    Texture2D = \"application/vnd.ms-package.3dmanufacturing-texture2d+xml\",\n    Production = \"application/vnd.ms-package.3dmanufacturing-production+xml\",\n    Slice = \"application/vnd.ms-package.3dmanufacturing-slice+xml\",\n    BeamLattice = \"application/vnd.ms-package.3dmanufacturing-beamlattice+xml\",\n    SecureContent = \"application/vnd.ms-package.3dmanufacturing-securecontent+xml\",\n\n    // Assets\n    Png = \"image/png\",\n    Jpeg = \"image/jpeg\",\n    Tiff = \"image/tiff\",\n    Xml = \"application/xml\",\n}\n\nexport const RelationshipDirName = \"_rels/\";\nexport const Object3dDirName = \"3D/\";\nexport const ModelFileName = `3dmodel.model`;\nexport const RelationshipFileName = `.rels`;\nexport const ContentTypeFileName = \"[Content_Types].xml\";\n\n/**\n * Common OPC and 3MF relationship Type URIs.\n */\nexport class Known3mfRelationshipTypes {\n    /**\n     * 3MF core: points to the main .model part of the package\n     */\n    public static readonly ThreeDimModel = \"http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel\";\n\n    /**\n     * OPC core: points to a package thumbnail (often used by 3MF packages)\n     */\n    public static readonly Thumbnail = \"http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail\";\n\n    /**\n     * 3MF (print ticket): optional printing settings part (rarely used by slicers)\n     */\n    public static readonly PrintTicket = \"http://schemas.microsoft.com/3dmanufacturing/2013/01/printticket\";\n\n    /**\n     * OPC core: indicates parts that must be preserved when editing the package\n     */\n    public static readonly MustPreserve = \"http://schemas.openxmlformats.org/package/2006/relationships/mustpreserve\";\n\n    /**\n     * Convenience set for quick checks\n     */\n    public static readonly Known: ReadonlySet<string> = new Set<string>([\n        Known3mfRelationshipTypes.ThreeDimModel,\n        Known3mfRelationshipTypes.Thumbnail,\n        Known3mfRelationshipTypes.PrintTicket,\n        Known3mfRelationshipTypes.MustPreserve,\n    ]);\n\n    /**\n     * Test if the relationship Type is one of the common known URIs above\n     * @param type\n     * @returns true if the relationship Type is one of the common known URIs above\n     */\n    public static IsKnown(type: string): boolean {\n        return Known3mfRelationshipTypes.Known.has(type);\n    }\n\n    /**\n     * test if the relationship Type is the main 3MF model entry point\n     * @param type\n     * @returns  true if the relationship Type is the main 3MF model entry point\n     */\n    public static IsThreeDimModel(type: string): boolean {\n        return type === Known3mfRelationshipTypes.ThreeDimModel;\n    }\n}\n\n/**\n *\n */\nexport interface I3mfContentTypes {\n    /**\n     *\n     */\n    items: I3mfContentType[];\n}\n\n/**\n *\n */\nexport interface I3mfContentType {\n    /**\n     *\n     */\n    ext: string;\n    /**\n     *\n     */\n    ct: string;\n}\n\n/**\n *\n */\nexport interface I3mfRelationships {\n    /**\n     *\n     */\n    items: I3mfRelationship[];\n}\n\n/**\n *\n */\nexport interface I3mfRelationship {\n    /**\n     *\n     */\n    id: string;\n\n    /**\n     *\n     */\n    type?: string;\n\n    /**\n     *\n     */\n    target?: string;\n}\n\n/**\n *\n */\nexport interface I3mfDocument {\n    /**\n     *\n     */\n    contentTypes: I3mfContentTypes;\n    /**\n     *\n     */\n    relationships: I3mfRelationships;\n    /**\n     *\n     */\n    model: I3mfModel;\n}\n"]}

package/3MF/core/model/3mf.opc.js

@@ -0,0 +1,91 @@
+import { __decorate } from "@onerjs/core/tslib.es6.js";
+import { XmlAttr, XmlName } from "../xml/xml.interfaces.js";
+import { OpenXmlContentTypesNamespace, OpenXmlRelationshipsNamespace } from "./3mf.opc.interfaces.js";
+/**
+ *
+ */
+let ThreeMfContentTypes = class ThreeMfContentTypes {
+    constructor() {
+        /**
+         *
+         */
+        this.items = [];
+    }
+};
+ThreeMfContentTypes = __decorate([
+    XmlName({ ns: OpenXmlContentTypesNamespace, name: "Types" })
+], ThreeMfContentTypes);
+export { ThreeMfContentTypes };
+/**
+ *
+ */
+let ThreeMfContentType = class ThreeMfContentType {
+    /**
+     *
+     * @param ext
+     * @param ct
+     */
+    constructor(ext, ct) {
+        this.ext = ext;
+        this.ct = ct;
+    }
+};
+__decorate([
+    XmlAttr({ name: { ns: OpenXmlContentTypesNamespace, name: "Extension" } })
+], ThreeMfContentType.prototype, "ext", void 0);
+__decorate([
+    XmlAttr({ name: { ns: OpenXmlContentTypesNamespace, name: "ContentType" } })
+], ThreeMfContentType.prototype, "ct", void 0);
+ThreeMfContentType = __decorate([
+    XmlName({ ns: OpenXmlContentTypesNamespace, name: "Default" })
+], ThreeMfContentType);
+export { ThreeMfContentType };
+/**
+ *
+ */
+let ThreeMfRelationships = class ThreeMfRelationships {
+    constructor() {
+        /**
+         *
+         */
+        this.items = [];
+    }
+};
+ThreeMfRelationships = __decorate([
+    XmlName({ ns: OpenXmlRelationshipsNamespace, name: "Relationships" })
+], ThreeMfRelationships);
+export { ThreeMfRelationships };
+/**
+ *
+ */
+let ThreeMfRelationship = class ThreeMfRelationship {
+    constructor(id, type, target) {
+        this.id = id;
+        this.type = type;
+        this.target = target;
+    }
+};
+__decorate([
+    XmlAttr({ name: "Id" })
+], ThreeMfRelationship.prototype, "id", void 0);
+__decorate([
+    XmlAttr({ name: "Type" })
+], ThreeMfRelationship.prototype, "type", void 0);
+__decorate([
+    XmlAttr({ name: "Target" })
+], ThreeMfRelationship.prototype, "target", void 0);
+ThreeMfRelationship = __decorate([
+    XmlName({ ns: OpenXmlRelationshipsNamespace, name: "Relationship" })
+], ThreeMfRelationship);
+export { ThreeMfRelationship };
+/**
+ *
+ */
+export class ThreeMfDocument {
+    constructor(contentTypes, relationships, model) {
+        this.contentTypes = contentTypes;
+        this.relationships = relationships;
+        this.model = model;
+    }
+}
+//# sourceMappingURL=3mf.opc.js.map

package/3MF/core/model/3mf.opc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"3mf.opc.js","sourceRoot":"","sources":["../../../../../../dev/serializers/src/3MF/core/model/3mf.opc.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAC;AAGnG;;GAEG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAAzB;QACH;;WAEG;QACH,UAAK,GAAyB,EAAE,CAAC;IACrC,CAAC;CAAA,CAAA;AALY,mBAAmB;IAD/B,OAAO,CAAC,EAAE,EAAE,EAAE,4BAA4B,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;GAChD,mBAAmB,CAK/B;;AAED;;GAEG;AAEI,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAY3B;;;;OAIG;IACH,YAAmB,GAAW,EAAE,EAAU;QACtC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACjB,CAAC;CACJ,CAAA;AAhBG;IADC,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,4BAA4B,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,CAAC;+CAC/D;AAKZ;IADC,OAAO,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,4BAA4B,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC;8CAClE;AAVF,kBAAkB;IAD9B,OAAO,CAAC,EAAE,EAAE,EAAE,4BAA4B,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;GAClD,kBAAkB,CAqB9B;;AAED;;GAEG;AAEI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAA1B;QACH;;WAEG;QACH,UAAK,GAA0B,EAAE,CAAC;IACtC,CAAC;CAAA,CAAA;AALY,oBAAoB;IADhC,OAAO,CAAC,EAAE,EAAE,EAAE,6BAA6B,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;GACzD,oBAAoB,CAKhC;;AAED;;GAEG;AAEI,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;IAmB5B,YAAY,EAAU,EAAE,IAAY,EAAE,MAAc;QAChD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CACJ,CAAA;AAnBG;IADC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;+CACb;AAMX;IADC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;iDACZ;AAMd;IADC,OAAO,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;mDACZ;AAjBP,mBAAmB;IAD/B,OAAO,CAAC,EAAE,EAAE,EAAE,6BAA6B,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;GACxD,mBAAmB,CAwB/B;;AAED;;GAEG;AACH,MAAM,OAAO,eAAe;IACxB,YACW,YAA8B,EAC9B,aAAgC,EAChC,KAAgB;QAFhB,iBAAY,GAAZ,YAAY,CAAkB;QAC9B,kBAAa,GAAb,aAAa,CAAmB;QAChC,UAAK,GAAL,KAAK,CAAW;IACxB,CAAC;CACP","sourcesContent":["import { XmlAttr, XmlName } from \"../xml/xml.interfaces\";\nimport type { I3mfModel } from \"./3mf.interfaces\";\nimport { OpenXmlContentTypesNamespace, OpenXmlRelationshipsNamespace } from \"./3mf.opc.interfaces\";\nimport type { I3mfContentTypes, I3mfContentType, I3mfRelationships, I3mfRelationship, I3mfDocument } from \"./3mf.opc.interfaces\";\n\n/**\n *\n */\n@XmlName({ ns: OpenXmlContentTypesNamespace, name: \"Types\" })\nexport class ThreeMfContentTypes implements I3mfContentTypes {\n    /**\n     *\n     */\n    items: ThreeMfContentType[] = [];\n}\n\n/**\n *\n */\n@XmlName({ ns: OpenXmlContentTypesNamespace, name: \"Default\" })\nexport class ThreeMfContentType implements I3mfContentType {\n    /**\n     *\n     */\n    @XmlAttr({ name: { ns: OpenXmlContentTypesNamespace, name: \"Extension\" } })\n    ext: string;\n    /**\n     *\n     */\n    @XmlAttr({ name: { ns: OpenXmlContentTypesNamespace, name: \"ContentType\" } })\n    ct: string;\n\n    /**\n     *\n     * @param ext\n     * @param ct\n     */\n    public constructor(ext: string, ct: string) {\n        this.ext = ext;\n        this.ct = ct;\n    }\n}\n\n/**\n *\n */\n@XmlName({ ns: OpenXmlRelationshipsNamespace, name: \"Relationships\" })\nexport class ThreeMfRelationships implements I3mfRelationships {\n    /**\n     *\n     */\n    items: ThreeMfRelationship[] = [];\n}\n\n/**\n *\n */\n@XmlName({ ns: OpenXmlRelationshipsNamespace, name: \"Relationship\" })\nexport class ThreeMfRelationship implements I3mfRelationship {\n    /**\n     *\n     */\n    @XmlAttr({ name: \"Id\" })\n    id: string;\n\n    /**\n     *\n     */\n    @XmlAttr({ name: \"Type\" })\n    type?: string;\n\n    /**\n     *\n     */\n    @XmlAttr({ name: \"Target\" })\n    target?: string;\n\n    constructor(id: string, type: string, target: string) {\n        this.id = id;\n        this.type = type;\n        this.target = target;\n    }\n}\n\n/**\n *\n */\nexport class ThreeMfDocument implements I3mfDocument {\n    public constructor(\n        public contentTypes: I3mfContentTypes,\n        public relationships: I3mfRelationships,\n        public model: I3mfModel\n    ) {}\n}\n"]}

package/3MF/core/model/3mf.serializer.d.ts

@@ -0,0 +1,118 @@
+import { ThreeMfModelBuilder } from "./3mf.builder.js";
+import { type I3mfDocument } from "./3mf.opc.interfaces.js";
+import type { I3mfModel } from "./3mf.interfaces.js";
+import { ST_Unit } from "./3mf.interfaces.js";
+/**
+ * Options controlling how meshes are exported into the 3MF model.
+ *
+ * Notes:
+ * - These flags are kept generic here and are expected to be interpreted by the concrete serializer/model builder.
+ * - Defaults are set in AbstractThreeMfSerializer.DEFAULT_3MF_EXPORTER_OPTIONS.
+ */
+export interface IThreeMfSerializerOptions {
+    /**
+     * define the unit. Default is millimeter
+     */
+    unit?: ST_Unit;
+    /**
+     *
+     */
+    metadata?: Record<string, string>;
+}
+/**
+ * Minimal contract for a 3MF serializer that can stream its output through a sink callback.
+ *
+ * The sink callback receives:
+ * - err: any error produced by the serialization pipeline (if any)
+ * - chunk: a chunk of bytes to append to the destination
+ * - final: true when this is the last chunk
+ *
+ * Important:
+ * - Implementations should call sink with final=true exactly once, or rely on the underlying zip lib to do so.
+ * - Consumers may ignore final if they just buffer everything.
+ */
+export interface I3mfSerializer<T> {
+    serializeAsync(sink: (err: any, chunk: Uint8Array, final: boolean) => void, ...meshes: Array<T>): Promise<void>;
+}
+/**
+ * Base class for 3MF serialization.
+ *
+ * Responsibilities:
+ * - Convert user meshes to a 3MF model (toModel).
+ * - Wrap the 3MF document parts into an OPC container (zip) and stream bytes through the sink.
+ *
+ * Non-responsibilities:
+ * - Providing/initializing the zip implementation (ensureZipLibReadyAsync is abstract).
+ * - Defining how meshes map to 3MF objects (toModel is abstract).
+ */
+export declare abstract class AbstractThreeMfSerializer<T, O extends IThreeMfSerializerOptions> implements I3mfSerializer<T> {
+    private _o;
+    /**
+     * @param opts user-provided options overriding defaults.
+     */
+    constructor(opts: O);
+    /**
+     * Expose the resolved options (defaults + overrides) as readonly.
+     */
+    get options(): Readonly<O>;
+    /**
+     * Generic 3MF binary serializer.
+     * Pipeline overview:
+     * 1. ensureZipLibReadyAsync provides a zip implementation (host-dependent).
+     * 2. Convert meshes into an I3mfDocument (OPC parts + model).
+     * 3. Create a zip target that streams through the provided sink.
+     * 4. Serialize XML parts into zip entries.
+     * 5. End the zip stream.
+     * @param sink a callback receiving byte chunks; enables streaming without buffering the full archive in memory.
+     * @param meshes the meshes to serialize.
+     * @returns
+     */
+    serializeAsync(sink: (err: any, chunk: Uint8Array, final: boolean) => void, ...meshes: Array<T>): Promise<void>;
+    /**
+     * Build a full 3MF OPC document from meshes.
+     *
+     * The default behavior uses ThreeMfDocumentBuilder with the model produced by toModel().
+     * Override if you need custom parts (textures, thumbnails, print ticket, etc.).
+     * @param meshes
+     * @returns
+     */
+    toDocument(...meshes: Array<T>): I3mfDocument | undefined;
+    /**
+     * Convert input meshes into a 3MF model.
+     *
+     * Implementations typically:
+     * - Create resources and objects.
+     * - Define build items (instances) when exportInstances is enabled.
+     * - Encode geometry and properties required by your pipeline.
+     */
+    abstract toModel(builder: ThreeMfModelBuilder, ...meshes: Array<T>): I3mfModel;
+    /**
+     * Provide a zip implementation for the current host/runtime.
+     *
+     * This might be provided by the framework implementation, but it could differ depending on the host
+     * (native, Node.js, browser, etc.).
+     *
+     * Expected shape (fflate-like):
+     * - return [ Zip, ZipDeflate ] at minimum.
+     *
+     * Notes:
+     * - In a browser, this might require bundler configuration or dynamic import.
+     * - In Node.js, this might be a direct import of "fflate" or another compatible implementation.
+     */
+    abstract ensureZipLibReadyAsync(): Promise<any>;
+}
+/**
+ * Convenience helpers around serializers.
+ */
+export declare class ThreeMf {
+    /**
+     * Serialize to a single in-memory buffer.
+     *
+     * This is a helper that buffers all chunks produced by serializeAsync, then concatenates them.
+     * Use serializeAsync directly if you want true streaming to a file/response.
+     * @param s
+     * @param meshes
+     * @returns
+     */
+    static SerializeToMemoryAsync<A>(s: I3mfSerializer<A>, ...meshes: Array<A>): Promise<Uint8Array | undefined>;
+}

package/3MF/core/model/3mf.serializer.js

@@ -0,0 +1,171 @@
+// 3MF
+import { ThreeMfDocumentBuilder, ThreeMfModelBuilder } from "./3mf.builder.js";
+import { ContentTypeFileName, ModelFileName, Object3dDirName, RelationshipDirName, RelationshipFileName } from "./3mf.opc.interfaces.js";
+import { ST_Unit } from "./3mf.interfaces.js";
+// XML
+import { XmlBuilder } from "../xml/xml.builder.js";
+import { XmlSerializer } from "../xml/xml.serializer.js";
+import { Utf8XmlWriterToBytes } from "../xml/xml.builder.bytes.js";
+/**
+ * Base class for 3MF serialization.
+ *
+ * Responsibilities:
+ * - Convert user meshes to a 3MF model (toModel).
+ * - Wrap the 3MF document parts into an OPC container (zip) and stream bytes through the sink.
+ *
+ * Non-responsibilities:
+ * - Providing/initializing the zip implementation (ensureZipLibReadyAsync is abstract).
+ * - Defining how meshes map to 3MF objects (toModel is abstract).
+ */
+export class AbstractThreeMfSerializer {
+    /**
+     * @param opts user-provided options overriding defaults.
+     */
+    constructor(opts) {
+        this._o = opts;
+    }
+    /**
+     * Expose the resolved options (defaults + overrides) as readonly.
+     */
+    get options() {
+        return this._o;
+    }
+    /**
+     * Generic 3MF binary serializer.
+     * Pipeline overview:
+     * 1. ensureZipLibReadyAsync provides a zip implementation (host-dependent).
+     * 2. Convert meshes into an I3mfDocument (OPC parts + model).
+     * 3. Create a zip target that streams through the provided sink.
+     * 4. Serialize XML parts into zip entries.
+     * 5. End the zip stream.
+     * @param sink a callback receiving byte chunks; enables streaming without buffering the full archive in memory.
+     * @param meshes the meshes to serialize.
+     * @returns
+     */
+    async serializeAsync(sink, ...meshes) {
+        // The zip library (e.g. fflate) may need dynamic import / polyfills depending on host.
+        // This is delegated to the concrete serializer implementation.
+        const lib = await this.ensureZipLibReadyAsync();
+        // If no lib is available, we silently do nothing today.
+        // Consider: throwing could be better to fail fast. Kept as-is to preserve current behavior.
+        if (!lib) {
+            return;
+        }
+        const zip = lib.Zip;
+        const zipDeflate = lib.ZipDeflate;
+        // We expect a "fflate-like" API. If it is missing, fail with an explicit error.
+        if (!zip || !zipDeflate) {
+            throw new Error("fflate Zip / ZipDeflate not available");
+        }
+        /**
+         * Adapt a fflate entry to our ByteSink interface used by Utf8XmlWriterToBytes.
+         *
+         * fflate entry.push(chunk, final) is the writer endpoint for compressed bytes.
+         * @param entry
+         * @returns
+         */
+        const makeByteSinkFromFflateEntry = function (entry) {
+            return { push: (chunk, final) => entry.push(chunk, final) };
+        };
+        /**
+         * Serialize an in-memory XML object into a compressed zip entry.
+         *
+         * Notes:
+         * - "object" here is expected to be a structure understood by XmlSerializer.
+         * - Compression level 6 is a reasonable default for speed/size tradeoff.
+         * @param target
+         * @param name
+         * @param object
+         */
+        const serializeEntry = function (target, name, object) {
+            const entry = new zipDeflate(name, { level: 6 });
+            target.add(entry);
+            // Convert XmlSerializer output into UTF-8 bytes and push to the zip entry.
+            const sink = makeByteSinkFromFflateEntry(entry);
+            const w = new Utf8XmlWriterToBytes(sink);
+            // Build XML declaration and serialize.
+            const b = new XmlBuilder(w).dec("1.0", "UTF-8");
+            const s = new XmlSerializer(b);
+            s.serialize(object);
+            // Ensure the writer flushes any pending bytes and closes the stream for this entry.
+            w.finish();
+        };
+        // Convert meshes into a 3MF document (content types + relationships + model part).
+        const doc = this.toDocument(...meshes);
+        if (!doc) {
+            // Nothing to write. Current behavior: no zip output.
+            return;
+        }
+        // Create the zip container. It will forward produced bytes to the provided sink.
+        const target = new zip(sink);
+        // Save the root content types part.
+        // In OPC, [Content_Types].xml defines the MIME/content types for the package parts.
+        serializeEntry(target, ContentTypeFileName, doc.contentTypes);
+        // Save relationships.
+        // In OPC, relationships live under _rels and map parts to each other.
+        serializeEntry(target, `${RelationshipDirName}${RelationshipFileName}`, doc.relationships);
+        // Save the 3D model part.
+        // In 3MF, the main model is typically under /3D/3dmodel.model.
+        serializeEntry(target, `${Object3dDirName}${ModelFileName}`, doc.model);
+        // Finalize the archive stream.
+        // This should trigger the zip implementation to call sink(..., final=true) when done.
+        target.end();
+    }
+    /**
+     * Build a full 3MF OPC document from meshes.
+     *
+     * The default behavior uses ThreeMfDocumentBuilder with the model produced by toModel().
+     * Override if you need custom parts (textures, thumbnails, print ticket, etc.).
+     * @param meshes
+     * @returns
+     */
+    toDocument(...meshes) {
+        const b = new ThreeMfModelBuilder().withUnit(this._o?.unit ?? ST_Unit.millimeter);
+        if (this.options.metadata) {
+            for (const m in this.options.metadata) {
+                b.withMetaData(m, this.options.metadata[m]);
+            }
+        }
+        return new ThreeMfDocumentBuilder().withModel(this.toModel(b, ...meshes)).build();
+    }
+}
+/**
+ * Convenience helpers around serializers.
+ */
+export class ThreeMf {
+    /**
+     * Serialize to a single in-memory buffer.
+     *
+     * This is a helper that buffers all chunks produced by serializeAsync, then concatenates them.
+     * Use serializeAsync directly if you want true streaming to a file/response.
+     * @param s
+     * @param meshes
+     * @returns
+     */
+    static async SerializeToMemoryAsync(s, ...meshes) {
+        const chunks = new Array();
+        let size = 0;
+        // Sink used by the zip stream. We ignore `final` because we buffer everything anyway.
+        // If `err` is used by the underlying zip lib, callers may want to detect/throw here.
+        const sink = function (err, chunk, _final) {
+            // Current behavior: ignore err and keep accumulating.
+            // Consider: if err is non-null, you might want to throw or record it.
+            chunks.push(chunk);
+            size += chunk.length;
+        };
+        await s.serializeAsync(sink, ...meshes);
+        // If nothing was written, return undefined (matches current behavior).
+        if (!size) {
+            return undefined;
+        }
+        // Concatenate chunks into a single Uint8Array.
+        const buffer = new Uint8Array(size);
+        let off = 0;
+        for (const c of chunks) {
+            buffer.set(c, off);
+            off += c.length;
+        }
+        return buffer;
+    }
+}
+//# sourceMappingURL=3mf.serializer.js.map

package/3MF/core/model/3mf.serializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"3mf.serializer.js","sourceRoot":"","sources":["../../../../../../dev/serializers/src/3MF/core/model/3mf.serializer.ts"],"names":[],"mappings":"AAAA,MAAM;AACN,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,eAAe,EAAE,mBAAmB,EAAE,oBAAoB,EAAqB,MAAM,sBAAsB,CAAC;AAEzJ,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,MAAM;AACN,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAiB,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAqC/E;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,yBAAyB;IAG3C;;OAEG;IACH,YAAmB,IAAO;QACtB,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,EAAE,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,cAAc,CAAC,IAA2D,EAAE,GAAG,MAAgB;QACxG,uFAAuF;QACvF,+DAA+D;QAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAEhD,wDAAwD;QACxD,4FAA4F;QAC5F,IAAI,CAAC,GAAG,EAAE,CAAC;YACP,OAAO;QACX,CAAC;QAED,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACpB,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;QAElC,gFAAgF;QAChF,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC7D,CAAC;QAED;;;;;;WAMG;QACH,MAAM,2BAA2B,GAAG,UAAU,KAAU;YACpD,OAAO,EAAE,IAAI,EAAE,CAAC,KAAU,EAAE,KAAU,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;QAC1E,CAAC,CAAC;QAEF;;;;;;;;;WASG;QACH,MAAM,cAAc,GAAG,UAAU,MAAW,EAAE,IAAY,EAAE,MAAW;YACnE,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAElB,2EAA2E;YAC3E,MAAM,IAAI,GAAG,2BAA2B,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,CAAC,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAEzC,uCAAuC;YACvC,MAAM,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,GAAG,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC;YAC/B,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAEpB,oFAAoF;YACpF,CAAC,CAAC,MAAM,EAAE,CAAC;QACf,CAAC,CAAC;QAEF,mFAAmF;QACnF,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,CAAC;QACvC,IAAI,CAAC,GAAG,EAAE,CAAC;YACP,qDAAqD;YACrD,OAAO;QACX,CAAC;QAED,iFAAiF;QACjF,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAE7B,oCAAoC;QACpC,oFAAoF;QACpF,cAAc,CAAC,MAAM,EAAE,mBAAmB,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;QAE9D,sBAAsB;QACtB,sEAAsE;QACtE,cAAc,CAAC,MAAM,EAAE,GAAG,mBAAmB,GAAG,oBAAoB,EAAE,EAAE,GAAG,CAAC,aAAa,CAAC,CAAC;QAE3F,0BAA0B;QAC1B,+DAA+D;QAC/D,cAAc,CAAC,MAAM,EAAE,GAAG,eAAe,GAAG,aAAa,EAAE,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QAExE,+BAA+B;QAC/B,sFAAsF;QACtF,MAAM,CAAC,GAAG,EAAE,CAAC;IACjB,CAAC;IAED;;;;;;;OAOG;IACI,UAAU,CAAC,GAAG,MAAgB;QACjC,MAAM,CAAC,GAAG,IAAI,mBAAmB,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;QAClF,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACxB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACpC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,CAAC;QACL,CAAC;QACD,OAAO,IAAI,sBAAsB,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IACtF,CAAC;CA0BJ;AAED;;GAEG;AACH,MAAM,OAAO,OAAO;IAChB;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAI,CAAoB,EAAE,GAAG,MAAgB;QACnF,MAAM,MAAM,GAAG,IAAI,KAAK,EAAc,CAAC;QACvC,IAAI,IAAI,GAAG,CAAC,CAAC;QAEb,sFAAsF;QACtF,qFAAqF;QACrF,MAAM,IAAI,GAAG,UAAU,GAAQ,EAAE,KAAiB,EAAE,MAAe;YAC/D,sDAAsD;YACtD,sEAAsE;YACtE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC;QACzB,CAAC,CAAC;QAEF,MAAM,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,MAAM,CAAC,CAAC;QAExC,uEAAuE;QACvE,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,+CAA+C;QAC/C,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACrB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YACnB,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC;QACpB,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ","sourcesContent":["// 3MF\r\nimport { ThreeMfDocumentBuilder, ThreeMfModelBuilder } from \"./3mf.builder\";\r\nimport { ContentTypeFileName, ModelFileName, Object3dDirName, RelationshipDirName, RelationshipFileName, type I3mfDocument } from \"./3mf.opc.interfaces\";\r\nimport type { I3mfModel } from \"./3mf.interfaces\";\r\nimport { ST_Unit } from \"./3mf.interfaces\";\r\n\r\n// XML\r\nimport { XmlBuilder } from \"../xml/xml.builder\";\r\nimport { XmlSerializer } from \"../xml/xml.serializer\";\r\nimport { type ByteSink, Utf8XmlWriterToBytes } from \"../xml/xml.builder.bytes\";\r\n\r\n/**\r\n * Options controlling how meshes are exported into the 3MF model.\r\n *\r\n * Notes:\r\n * - These flags are kept generic here and are expected to be interpreted by the concrete serializer/model builder.\r\n * - Defaults are set in AbstractThreeMfSerializer.DEFAULT_3MF_EXPORTER_OPTIONS.\r\n */\r\nexport interface IThreeMfSerializerOptions {\r\n    /**\r\n     * define the unit. Default is millimeter\r\n     */\r\n    unit?: ST_Unit;\r\n\r\n    /**\r\n     *\r\n     */\r\n    metadata?: Record<string, string>;\r\n}\r\n\r\n/**\r\n * Minimal contract for a 3MF serializer that can stream its output through a sink callback.\r\n *\r\n * The sink callback receives:\r\n * - err: any error produced by the serialization pipeline (if any)\r\n * - chunk: a chunk of bytes to append to the destination\r\n * - final: true when this is the last chunk\r\n *\r\n * Important:\r\n * - Implementations should call sink with final=true exactly once, or rely on the underlying zip lib to do so.\r\n * - Consumers may ignore final if they just buffer everything.\r\n */\r\nexport interface I3mfSerializer<T> {\r\n    serializeAsync(sink: (err: any, chunk: Uint8Array, final: boolean) => void, ...meshes: Array<T>): Promise<void>;\r\n}\r\n\r\n/**\r\n * Base class for 3MF serialization.\r\n *\r\n * Responsibilities:\r\n * - Convert user meshes to a 3MF model (toModel).\r\n * - Wrap the 3MF document parts into an OPC container (zip) and stream bytes through the sink.\r\n *\r\n * Non-responsibilities:\r\n * - Providing/initializing the zip implementation (ensureZipLibReadyAsync is abstract).\r\n * - Defining how meshes map to 3MF objects (toModel is abstract).\r\n */\r\nexport abstract class AbstractThreeMfSerializer<T, O extends IThreeMfSerializerOptions> implements I3mfSerializer<T> {\r\n    private _o: O;\r\n\r\n    /**\r\n     * @param opts user-provided options overriding defaults.\r\n     */\r\n    public constructor(opts: O) {\r\n        this._o = opts;\r\n    }\r\n\r\n    /**\r\n     * Expose the resolved options (defaults + overrides) as readonly.\r\n     */\r\n    public get options(): Readonly<O> {\r\n        return this._o;\r\n    }\r\n\r\n    /**\r\n     * Generic 3MF binary serializer.\r\n     * Pipeline overview:\r\n     * 1. ensureZipLibReadyAsync provides a zip implementation (host-dependent).\r\n     * 2. Convert meshes into an I3mfDocument (OPC parts + model).\r\n     * 3. Create a zip target that streams through the provided sink.\r\n     * 4. Serialize XML parts into zip entries.\r\n     * 5. End the zip stream.\r\n     * @param sink a callback receiving byte chunks; enables streaming without buffering the full archive in memory.\r\n     * @param meshes the meshes to serialize.\r\n     * @returns\r\n     */\r\n    public async serializeAsync(sink: (err: any, chunk: Uint8Array, final: boolean) => void, ...meshes: Array<T>): Promise<void> {\r\n        // The zip library (e.g. fflate) may need dynamic import / polyfills depending on host.\r\n        // This is delegated to the concrete serializer implementation.\r\n        const lib = await this.ensureZipLibReadyAsync();\r\n\r\n        // If no lib is available, we silently do nothing today.\r\n        // Consider: throwing could be better to fail fast. Kept as-is to preserve current behavior.\r\n        if (!lib) {\r\n            return;\r\n        }\r\n\r\n        const zip = lib.Zip;\r\n        const zipDeflate = lib.ZipDeflate;\r\n\r\n        // We expect a \"fflate-like\" API. If it is missing, fail with an explicit error.\r\n        if (!zip || !zipDeflate) {\r\n            throw new Error(\"fflate Zip / ZipDeflate not available\");\r\n        }\r\n\r\n        /**\r\n         * Adapt a fflate entry to our ByteSink interface used by Utf8XmlWriterToBytes.\r\n         *\r\n         * fflate entry.push(chunk, final) is the writer endpoint for compressed bytes.\r\n         * @param entry\r\n         * @returns\r\n         */\r\n        const makeByteSinkFromFflateEntry = function (entry: any): ByteSink {\r\n            return { push: (chunk: any, final: any) => entry.push(chunk, final) };\r\n        };\r\n\r\n        /**\r\n         * Serialize an in-memory XML object into a compressed zip entry.\r\n         *\r\n         * Notes:\r\n         * - \"object\" here is expected to be a structure understood by XmlSerializer.\r\n         * - Compression level 6 is a reasonable default for speed/size tradeoff.\r\n         * @param target\r\n         * @param name\r\n         * @param object\r\n         */\r\n        const serializeEntry = function (target: any, name: string, object: any): void {\r\n            const entry = new zipDeflate(name, { level: 6 });\r\n            target.add(entry);\r\n\r\n            // Convert XmlSerializer output into UTF-8 bytes and push to the zip entry.\r\n            const sink = makeByteSinkFromFflateEntry(entry);\r\n            const w = new Utf8XmlWriterToBytes(sink);\r\n\r\n            // Build XML declaration and serialize.\r\n            const b = new XmlBuilder(w).dec(\"1.0\", \"UTF-8\");\r\n            const s = new XmlSerializer(b);\r\n            s.serialize(object);\r\n\r\n            // Ensure the writer flushes any pending bytes and closes the stream for this entry.\r\n            w.finish();\r\n        };\r\n\r\n        // Convert meshes into a 3MF document (content types + relationships + model part).\r\n        const doc = this.toDocument(...meshes);\r\n        if (!doc) {\r\n            // Nothing to write. Current behavior: no zip output.\r\n            return;\r\n        }\r\n\r\n        // Create the zip container. It will forward produced bytes to the provided sink.\r\n        const target = new zip(sink);\r\n\r\n        // Save the root content types part.\r\n        // In OPC, [Content_Types].xml defines the MIME/content types for the package parts.\r\n        serializeEntry(target, ContentTypeFileName, doc.contentTypes);\r\n\r\n        // Save relationships.\r\n        // In OPC, relationships live under _rels and map parts to each other.\r\n        serializeEntry(target, `${RelationshipDirName}${RelationshipFileName}`, doc.relationships);\r\n\r\n        // Save the 3D model part.\r\n        // In 3MF, the main model is typically under /3D/3dmodel.model.\r\n        serializeEntry(target, `${Object3dDirName}${ModelFileName}`, doc.model);\r\n\r\n        // Finalize the archive stream.\r\n        // This should trigger the zip implementation to call sink(..., final=true) when done.\r\n        target.end();\r\n    }\r\n\r\n    /**\r\n     * Build a full 3MF OPC document from meshes.\r\n     *\r\n     * The default behavior uses ThreeMfDocumentBuilder with the model produced by toModel().\r\n     * Override if you need custom parts (textures, thumbnails, print ticket, etc.).\r\n     * @param meshes\r\n     * @returns\r\n     */\r\n    public toDocument(...meshes: Array<T>): I3mfDocument | undefined {\r\n        const b = new ThreeMfModelBuilder().withUnit(this._o?.unit ?? ST_Unit.millimeter);\r\n        if (this.options.metadata) {\r\n            for (const m in this.options.metadata) {\r\n                b.withMetaData(m, this.options.metadata[m]);\r\n            }\r\n        }\r\n        return new ThreeMfDocumentBuilder().withModel(this.toModel(b, ...meshes)).build();\r\n    }\r\n\r\n    /**\r\n     * Convert input meshes into a 3MF model.\r\n     *\r\n     * Implementations typically:\r\n     * - Create resources and objects.\r\n     * - Define build items (instances) when exportInstances is enabled.\r\n     * - Encode geometry and properties required by your pipeline.\r\n     */\r\n    public abstract toModel(builder: ThreeMfModelBuilder, ...meshes: Array<T>): I3mfModel;\r\n\r\n    /**\r\n     * Provide a zip implementation for the current host/runtime.\r\n     *\r\n     * This might be provided by the framework implementation, but it could differ depending on the host\r\n     * (native, Node.js, browser, etc.).\r\n     *\r\n     * Expected shape (fflate-like):\r\n     * - return [ Zip, ZipDeflate ] at minimum.\r\n     *\r\n     * Notes:\r\n     * - In a browser, this might require bundler configuration or dynamic import.\r\n     * - In Node.js, this might be a direct import of \"fflate\" or another compatible implementation.\r\n     */\r\n    public abstract ensureZipLibReadyAsync(): Promise<any>;\r\n}\r\n\r\n/**\r\n * Convenience helpers around serializers.\r\n */\r\nexport class ThreeMf {\r\n    /**\r\n     * Serialize to a single in-memory buffer.\r\n     *\r\n     * This is a helper that buffers all chunks produced by serializeAsync, then concatenates them.\r\n     * Use serializeAsync directly if you want true streaming to a file/response.\r\n     * @param s\r\n     * @param meshes\r\n     * @returns\r\n     */\r\n    public static async SerializeToMemoryAsync<A>(s: I3mfSerializer<A>, ...meshes: Array<A>): Promise<Uint8Array | undefined> {\r\n        const chunks = new Array<Uint8Array>();\r\n        let size = 0;\r\n\r\n        // Sink used by the zip stream. We ignore `final` because we buffer everything anyway.\r\n        // If `err` is used by the underlying zip lib, callers may want to detect/throw here.\r\n        const sink = function (err: any, chunk: Uint8Array, _final: boolean) {\r\n            // Current behavior: ignore err and keep accumulating.\r\n            // Consider: if err is non-null, you might want to throw or record it.\r\n            chunks.push(chunk);\r\n            size += chunk.length;\r\n        };\r\n\r\n        await s.serializeAsync(sink, ...meshes);\r\n\r\n        // If nothing was written, return undefined (matches current behavior).\r\n        if (!size) {\r\n            return undefined;\r\n        }\r\n\r\n        // Concatenate chunks into a single Uint8Array.\r\n        const buffer = new Uint8Array(size);\r\n        let off = 0;\r\n        for (const c of chunks) {\r\n            buffer.set(c, off);\r\n            off += c.length;\r\n        }\r\n        return buffer;\r\n    }\r\n}\r\n"]}

package/3MF/core/model/3mf.types.d.ts

@@ -0,0 +1,46 @@
+/** Alias type for number array or Float32Array */
+export type ThreeMfFloatArray = number[] | Float32Array;
+/** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
+export type ThreeMfIndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
+/**
+ * Interface used to define object data independaly of framework
+ */
+export interface I3mfVertexData {
+    /**
+     * An array of the x, y, z position of each vertex  [...., x, y, z, .....]
+     */
+    positions: ThreeMfFloatArray | null;
+    /**
+     * An array of i, j, k the three vertex indices required for each triangular facet  [...., i, j, k .....]
+     */
+    indices: ThreeMfIndicesArray | null;
+    /**
+     * An array of the x, y, z normal vector of each vertex  [...., x, y, z, .....]
+     */
+    normals?: ThreeMfFloatArray | null;
+    /**
+     * An array of the r, g, b, a, color of each vertex  [...., r, g, b, a, .....]
+     */
+    colors?: ThreeMfFloatArray | null;
+}
+/**
+ * interface used to abstact rgb colors from any framework.
+ */
+export interface I3mfRGBAColor {
+    /**
+     *
+     */
+    r: number;
+    /**
+     *
+     */
+    g: number;
+    /**
+     *
+     */
+    b: number;
+    /**
+     *
+     */
+    a?: number;
+}

package/3MF/core/model/3mf.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=3mf.types.js.map

package/3MF/core/model/3mf.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"3mf.types.js","sourceRoot":"","sources":["../../../../../../dev/serializers/src/3MF/core/model/3mf.types.ts"],"names":[],"mappings":"","sourcesContent":["/** Alias type for number array or Float32Array */\r\nexport type ThreeMfFloatArray = number[] | Float32Array;\r\n/** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */\r\nexport type ThreeMfIndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;\r\n\r\n/**\r\n * Interface used to define object data independaly of framework\r\n */\r\nexport interface I3mfVertexData {\r\n    /**\r\n     * An array of the x, y, z position of each vertex  [...., x, y, z, .....]\r\n     */\r\n    positions: ThreeMfFloatArray | null;\r\n    /**\r\n     * An array of i, j, k the three vertex indices required for each triangular facet  [...., i, j, k .....]\r\n     */\r\n    indices: ThreeMfIndicesArray | null;\r\n    /**\r\n     * An array of the x, y, z normal vector of each vertex  [...., x, y, z, .....]\r\n     */\r\n    normals?: ThreeMfFloatArray | null;\r\n    /**\r\n     * An array of the r, g, b, a, color of each vertex  [...., r, g, b, a, .....]\r\n     */\r\n    colors?: ThreeMfFloatArray | null;\r\n}\r\n\r\n/**\r\n * interface used to abstact rgb colors from any framework.\r\n */\r\nexport interface I3mfRGBAColor {\r\n    /**\r\n     *\r\n     */\r\n    r: number;\r\n    /**\r\n     *\r\n     */\r\n    g: number;\r\n    /**\r\n     *\r\n     */\r\n    b: number;\r\n    /**\r\n     *\r\n     */\r\n    a?: number;\r\n}\r\n"]}

package/3MF/core/model/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./3mf.interfaces.js";
+export * from "./3mf.opc.interfaces.js";
+export * from "./3mf.opc.js";
+export * from "./3mf.js";
+export * from "./3mf.builder.js";
+export * from "./3mf.types.js";
+export * from "./3mf.serializer.js";

package/3MF/core/model/index.js

@@ -0,0 +1,8 @@
+export * from "./3mf.interfaces.js";
+export * from "./3mf.opc.interfaces.js";
+export * from "./3mf.opc.js";
+export * from "./3mf.js";
+export * from "./3mf.builder.js";
+export * from "./3mf.types.js";
+export * from "./3mf.serializer.js";
+//# sourceMappingURL=index.js.map

package/3MF/core/model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../dev/serializers/src/3MF/core/model/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC","sourcesContent":["export * from \"./3mf.interfaces\";\r\nexport * from \"./3mf.opc.interfaces\";\r\nexport * from \"./3mf.opc\";\r\nexport * from \"./3mf\";\r\nexport * from \"./3mf.builder\";\r\nexport * from \"./3mf.types\";\r\nexport * from \"./3mf.serializer\";\r\n"]}

package/3MF/core/xml/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./xml.interfaces.js";
+export * from "./xml.serializer.js";
+export * from "./xml.serializer.format.js";
+export * from "./xml.builder.js";
+export * from "./xml.builder.string.js";
+export * from "./xml.builder.bytes.js";

package/3MF/core/xml/index.js

@@ -0,0 +1,7 @@
+export * from "./xml.interfaces.js";
+export * from "./xml.serializer.js";
+export * from "./xml.serializer.format.js";
+export * from "./xml.builder.js";
+export * from "./xml.builder.string.js";
+export * from "./xml.builder.bytes.js";
+//# sourceMappingURL=index.js.map

package/3MF/core/xml/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../dev/serializers/src/3MF/core/xml/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC","sourcesContent":["export * from \"./xml.interfaces\";\r\nexport * from \"./xml.serializer\";\r\nexport * from \"./xml.serializer.format\";\r\nexport * from \"./xml.builder\";\r\nexport * from \"./xml.builder.string\";\r\nexport * from \"./xml.builder.bytes\";\r\n"]}

package/3MF/core/xml/xml.builder.bytes.d.ts

@@ -0,0 +1,33 @@
+import type { IXmlWriter } from "./xml.builder.js";
+/** */
+export type ByteSink = {
+    push(chunk: Uint8Array, final?: boolean): void;
+};
+/** */
+export declare class Utf8XmlWriterToBytes implements IXmlWriter {
+    private readonly _sink;
+    private readonly _opts;
+    /** */
+    count: number;
+    private _encoder;
+    private _pending;
+    private _pendingChars;
+    constructor(_sink: ByteSink, _opts?: {
+        flushChars?: number;
+    });
+    /**
+     * @param data
+     * @returns
+     */
+    write(...data: string[]): IXmlWriter;
+    /**
+     * @returns
+     */
+    flush(): this;
+    /**
+     */
+    finish(): void;
+    /**
+     */
+    clear(): void;
+}