Add support for the 3MF Production extension

Also add ModelLoader.

Author: tomasf

Package.resolved

@@ -10,7 +10,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/tomasf/Zip.git", from: "2.1.0"),
-        .package(url: "https://github.com/tomasf/Nodal.git", from: "0.3.1")
+        .package(url: "https://github.com/tomasf/Nodal.git", from: "0.3.2")
     ],
     targets: [
         .target(

Package.swift

@@ -1,4 +1,5 @@
 import Foundation
+import Nodal
 
 internal extension Dictionary {
     static func +(lhs: Self, rhs: Self) -> Self {
@@ -15,3 +16,36 @@ internal extension Collection {
         isEmpty ? nil : self
     }
 }
+
+extension Collection where Element: Sendable {
+    func asyncMap<T: Sendable>(_ transform: @Sendable @escaping (Element) async throws -> T) async rethrows -> [T] {
+        try await withThrowingTaskGroup(of: (Int, T).self) { group in
+            for (index, element) in self.enumerated() {
+                group.addTask {
+                    let value = try await transform(element)
+                    return (index, value)
+                }
+            }
+
+            var results = Array<T?>(repeating: nil, count: self.count)
+            for try await (index, result) in group {
+                results[index] = result
+            }
+
+            return results.map { $0! }
+        }
+    }
+}
+
+extension URL: XMLValueCodable {
+    public var xmlStringValue: String {
+        relativePath
+    }
+
+    public init(xmlStringValue string: String) throws {
+        guard let url = URL(string: string) else {
+            throw XMLValueError.invalidFormat(expected: "URI", found: string)
+        }
+        self = url
+    }
+}

Sources/ThreeMF/Extensions.swift

@@ -0,0 +1,22 @@
+import Foundation
+import Nodal
+
+public struct Build: Sendable, XMLElementCodable {
+    public var items: [Item]
+    public var uuid: UUID?
+
+    public init(items: [Item], uuid: UUID? = nil) {
+        self.items = items
+        self.uuid = uuid
+    }
+
+    public func encode(to element: Node) {
+        element.setValue(uuid ?? .uuidIfProduction, forAttribute: Production.UUID)
+        element.encode(items, elementName: Core.item)
+    }
+
+    public init(from element: Node) throws {
+        uuid = try element.value(forAttribute: Production.UUID)
+        items = try element.decode(elementName: Core.item)
+    }
+}

Sources/ThreeMF/Model/Build.swift

@@ -7,25 +7,34 @@ public struct Item: Sendable, XMLElementCodable {
     public var partNumber: String?
     public var metadata: [Metadata]
     public var customAttributes: [ExpandedName: String]
+    public var path: URL?
+    public var uuid: UUID?
 
     public init(
         objectID: ResourceID,
         transform: Matrix3D? = nil,
         partNumber: String? = nil,
         metadata: [Metadata] = [],
-        customAttributes: [ExpandedName: String] = [:]
+        customAttributes: [ExpandedName: String] = [:],
+        path: URL? = nil,
+        uuid: UUID? = nil
     ) {
         self.objectID = objectID
         self.transform = transform
         self.partNumber = partNumber
         self.metadata = metadata
         self.customAttributes = customAttributes
+        self.path = path
+        self.uuid = uuid
     }
 
     public func encode(to element: Node) {
         element.setValue(objectID, forAttribute: .objectID)
         element.setValue(transform, forAttribute: .transform)
         element.setValue(partNumber, forAttribute: .partNumber)
+        element.setValue(uuid ?? .uuidIfProduction, forAttribute: Production.UUID)
+        element.setValue(path, forAttribute: Production.path)
+
         element.encode(metadata, elementName: Core.metadata, containedIn: Core.metadataGroup)
         for (name, value) in customAttributes {
             element.setValue(value, forAttribute: name)
@@ -36,9 +45,11 @@ public struct Item: Sendable, XMLElementCodable {
         objectID = try element.value(forAttribute: .objectID)
         transform = try element.value(forAttribute: .transform)
         partNumber = try element.value(forAttribute: .partNumber)
+        uuid = try element.value(forAttribute: Production.UUID)
+        path = try element.value(forAttribute: Production.path)
         metadata = try element.decode(elementName: Core.metadata, containedIn: Core.metadataGroup)
 
-        let knownAttributes: Set<ExpandedName> = [.objectID, .transform, .partNumber, Core.metadataGroup]
+        let knownAttributes: Set<ExpandedName> = [.objectID, .transform, .partNumber, Core.metadataGroup, Production.UUID, Production.path]
         customAttributes = element.namespacedAttributes.filter { !knownAttributes.contains($0.key) }
     }
 }

Sources/ThreeMF/Model/Item.swift

@@ -1,6 +1,14 @@
 import Foundation
 import Nodal
 
+@TaskLocal internal var requiredExtensions: Set<Namespace> = []
+
+internal extension UUID {
+    static var uuidIfProduction: UUID? {
+        requiredExtensions.contains(.production) ? UUID() : nil
+    }
+}
+
 public struct Model: Sendable, XMLElementCodable {
     public var unit: Unit?
     public var xmlLanguageCode: String?
@@ -12,7 +20,7 @@ public struct Model: Sendable, XMLElementCodable {
 
     public var metadata: [Metadata]
     public var resources: ResourceContainer
-    public var buildItems: [Item]
+    public var build: Build
 
     public init(
         unit: Unit? = nil,
@@ -23,7 +31,7 @@ public struct Model: Sendable, XMLElementCodable {
         customNamespaces: [String: String] = [:], // Prefix: URI
         metadata: [Metadata] = [],
         resources: [any Resource] = [],
-        buildItems: [Item] = []
+        build: Build
     ) {
         self.unit = unit
         self.xmlLanguageCode = xmlLanguageCode
@@ -34,18 +42,35 @@ public struct Model: Sendable, XMLElementCodable {
 
         self.metadata = metadata
         self.resources = ResourceContainer(resources: resources)
-        self.buildItems = buildItems
+        self.build = build
+    }
+
+    public init(
+        unit: Unit? = nil,
+        xmlLanguageCode: String? = nil,
+        languageCode: String? = nil,
+        requiredExtensions: Set<Namespace> = [],
+        recommendedExtensions: Set<Namespace> = [],
+        customNamespaces: [String: String] = [:], // Prefix: URI
+        metadata: [Metadata] = [],
+        resources: [any Resource] = [],
+        buildItems: [Item] = []
+    ) {
+        let build = Build(items: buildItems)
+        self.init(unit: unit, xmlLanguageCode: xmlLanguageCode, languageCode: languageCode, requiredExtensions: requiredExtensions, recommendedExtensions: recommendedExtensions, customNamespaces: customNamespaces, metadata: metadata, resources: resources, build: build)
     }
 
     public func encode(to element: Node) {
-        element.setValue(unit, forAttribute: .unit)
-        element.setValue(xmlLanguageCode, forAttribute: XML.lang)
-        element.setValue(languageCode, forAttribute: .language)
-        element.setValue(requiredExtensions.compactMap(\.outputPrefix).nonEmpty, forAttribute: .requiredExtensions)
-        element.setValue(recommendedExtensions.compactMap(\.outputPrefix).nonEmpty, forAttribute: .recommendedExtensions)
-        element.encode(metadata, elementName: Core.metadata)
-        element.encode(resources, elementName: Core.resources)
-        element.encode(buildItems, elementName: Core.item, containedIn: Core.build)
+        $requiredExtensions.withValue(requiredExtensions) {
+            element.setValue(unit, forAttribute: .unit)
+            element.setValue(xmlLanguageCode, forAttribute: XML.lang)
+            element.setValue(languageCode, forAttribute: .language)
+            element.setValue(requiredExtensions.compactMap(\.outputPrefix).nonEmpty, forAttribute: .requiredExtensions)
+            element.setValue(recommendedExtensions.compactMap(\.outputPrefix).nonEmpty, forAttribute: .recommendedExtensions)
+            element.encode(metadata, elementName: Core.metadata)
+            element.encode(resources, elementName: Core.resources)
+            element.encode(build, elementName: Core.build)
+        }
     }
 
     public init(from element: Node) throws {
@@ -70,6 +95,6 @@ public struct Model: Sendable, XMLElementCodable {
 
         metadata = try element.decode(elementName: Core.metadata)
         resources = try element.decode(elementName: Core.resources)
-        buildItems = try element.decode(elementName: Core.item, containedIn: Core.build)
+        build = try element.decode(elementName: Core.build)
     }
 }

Sources/ThreeMF/Model/Model.swift

@@ -85,4 +85,7 @@ extension AttributeName where Self == ExpandedName {
     static var startIndex: Self { attribute("startindex") }
     static var endIndex: Self { attribute("endindex") }
     static var identifier: Self { attribute("identifier") }
+
+    // MARK: - Alternatives
+    static var modelResolution: Self { attribute("modelresolution") }
 }

Sources/ThreeMF/Namespace/Attributes.swift

@@ -12,9 +12,19 @@ public struct Namespace: Hashable, Sendable {
 }
 
 internal extension Namespace {
-    static var known: Set<Self> {
-        [.core, .triangleSets, .mirroring, .materials, .volumetric, .implicit, .boolean, .displacement, .slice]
-    }
+    static var known: Set<Self> {[
+        .core,
+        .triangleSets,
+        .mirroring,
+        .materials,
+        .volumetric,
+        .implicit,
+        .boolean,
+        .displacement,
+        .slice,
+        .production,
+        .alternatives
+    ]}
 
     static func knownNamespace(for uri: String) -> Self? {
         return Self.known.first(where: { $0.uri == uri })
@@ -50,6 +60,16 @@ public extension Namespace {
         outputPrefix: "m"
     )
 
+    static let production = Self(
+        uri: "http://schemas.microsoft.com/3dmanufacturing/production/2015/06",
+        outputPrefix: "p"
+    )
+
+    static let alternatives = Self(
+        uri: "http://schemas.microsoft.com/3dmanufacturing/production/alternatives/2021/04",
+        outputPrefix: "pa"
+    )
+
     static let mirroring = Self(
         uri: "http://schemas.microsoft.com/3dmanufacturing/mirroring/2021/07",
         outputPrefix: "mm"

Sources/ThreeMF/Namespace/Namespace.swift

@@ -0,0 +1,24 @@
+import Foundation
+import Nodal
+
+internal struct Production: NamespaceSpecification {
+    static let namespace = Namespace.production
+
+    static let path = attributeName("path")
+    static let UUID = attributeName("UUID")
+}
+
+internal struct Alternatives: NamespaceSpecification {
+    static let namespace = Namespace.alternatives
+
+    static let alternatives = elementName("alternatives")
+    static let alternative = elementName("alternative")
+
+    static let modelResolution = attributeName("modelresolution")
+}
+
+public enum ModelResolution: String, Sendable, Hashable, XMLValueCodable {
+    case full = "fullres"
+    case low = "lowres"
+    case obfuscated
+}