@ifc-lite/export 1.17.2 → 1.18.0

package/dist/step-exporter.js

@@ -2,10 +2,10 @@
  * 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/. */
 import { EntityExtractor, generateHeader, getAttributeNames, serializeValue, ref, } from '@ifc-lite/parser';
-import { PropertyValueType, QuantityType } from '@ifc-lite/data';
 import { generateIfcGuid } from '@ifc-lite/encoding';
 import { collectReferencedEntityIds, getVisibleEntityIds, collectStyleEntities } from './reference-collector.js';
 import { convertStepLine, needsConversion } from './schema-converter.js';
+import { escapeStepString, toStepReal, quantityTypeToIfcType, serializePropertyValue, serializeAttributeValue, serializeStepArgs, serializeStepValue, splitTopLevelArgs, splitTopLevelStepArguments, } from './step-serialization.js';
 /**
  * IFC STEP file exporter
  */
@@ -17,8 +17,11 @@ export class StepExporter {
     constructor(dataStore, mutationView) {
         this.dataStore = dataStore;
         this.mutationView = mutationView || null;
-        // Start new IDs after the highest existing ID
-        this.nextExpressId = this.findMaxExpressId() + 1;
+        const maxExisting = this.findMaxExpressId();
+        const overlayWatermark = typeof mutationView?.peekNextExpressId === 'function'
+            ? mutationView.peekNextExpressId() - 1
+            : 0;
+        this.nextExpressId = Math.max(maxExisting, overlayWatermark) + 1;
         this.entityExtractor = dataStore.source ? new EntityExtractor(dataStore.source) : null;
     }
     /**
@@ -279,12 +282,12 @@ export class StepExporter {
                 const crs = gm.projectedCRS;
                 const crsId = this.nextExpressId++;
                 // IfcProjectedCRS(Name, Description, GeodeticDatum, VerticalDatum, MapProjection, MapZone, MapUnit)
-                const name = crs.name ? `'${this.escapeStepString(String(crs.name))}'` : '$';
-                const desc = crs.description ? `'${this.escapeStepString(String(crs.description))}'` : '$';
-                const datum = crs.geodeticDatum ? `'${this.escapeStepString(String(crs.geodeticDatum))}'` : '$';
-                const vDatum = crs.verticalDatum ? `'${this.escapeStepString(String(crs.verticalDatum))}'` : '$';
-                const proj = crs.mapProjection ? `'${this.escapeStepString(String(crs.mapProjection))}'` : '$';
-                const zone = crs.mapZone ? `'${this.escapeStepString(String(crs.mapZone))}'` : '$';
+                const name = crs.name ? `'${escapeStepString(String(crs.name))}'` : '$';
+                const desc = crs.description ? `'${escapeStepString(String(crs.description))}'` : '$';
+                const datum = crs.geodeticDatum ? `'${escapeStepString(String(crs.geodeticDatum))}'` : '$';
+                const vDatum = crs.verticalDatum ? `'${escapeStepString(String(crs.verticalDatum))}'` : '$';
+                const proj = crs.mapProjection ? `'${escapeStepString(String(crs.mapProjection))}'` : '$';
+                const zone = crs.mapZone ? `'${escapeStepString(String(crs.mapZone))}'` : '$';
                 const mapUnitRef = crs.mapUnit
                     ? `#${this.resolveMapUnitReference(String(crs.mapUnit), newGeorefLines)}`
                     : '$';
@@ -295,12 +298,12 @@ export class StepExporter {
                 if (contextId) {
                     const mc = gm.mapConversion || {};
                     const mcId = this.nextExpressId++;
-                    const eastings = this.toStepReal(Number(mc.eastings) || 0);
-                    const northings = this.toStepReal(Number(mc.northings) || 0);
-                    const height = this.toStepReal(Number(mc.orthogonalHeight) || 0);
-                    const abscissa = mc.xAxisAbscissa !== undefined ? this.toStepReal(Number(mc.xAxisAbscissa)) : '$';
-                    const ordinate = mc.xAxisOrdinate !== undefined ? this.toStepReal(Number(mc.xAxisOrdinate)) : '$';
-                    const scale = mc.scale !== undefined ? this.toStepReal(Number(mc.scale)) : '$';
+                    const eastings = toStepReal(Number(mc.eastings) || 0);
+                    const northings = toStepReal(Number(mc.northings) || 0);
+                    const height = toStepReal(Number(mc.orthogonalHeight) || 0);
+                    const abscissa = mc.xAxisAbscissa !== undefined ? toStepReal(Number(mc.xAxisAbscissa)) : '$';
+                    const ordinate = mc.xAxisOrdinate !== undefined ? toStepReal(Number(mc.xAxisOrdinate)) : '$';
+                    const scale = mc.scale !== undefined ? toStepReal(Number(mc.scale)) : '$';
                     // IfcMapConversion(SourceCRS, TargetCRS, Eastings, Northings, OrthogonalHeight, XAxisAbscissa, XAxisOrdinate, Scale)
                     newGeorefLines.push(`#${mcId}=IFCMAPCONVERSION(#${contextId},#${crsId},${eastings},${northings},${height},${abscissa},${ordinate},${scale});`);
                     newEntityCount++;
@@ -315,12 +318,12 @@ export class StepExporter {
                 if (contextId) {
                     const mc = gm.mapConversion;
                     const mcId = this.nextExpressId++;
-                    const eastings = this.toStepReal(Number(mc.eastings) || 0);
-                    const northings = this.toStepReal(Number(mc.northings) || 0);
-                    const height = this.toStepReal(Number(mc.orthogonalHeight) || 0);
-                    const abscissa = mc.xAxisAbscissa !== undefined ? this.toStepReal(Number(mc.xAxisAbscissa)) : '$';
-                    const ordinate = mc.xAxisOrdinate !== undefined ? this.toStepReal(Number(mc.xAxisOrdinate)) : '$';
-                    const scale = mc.scale !== undefined ? this.toStepReal(Number(mc.scale)) : '$';
+                    const eastings = toStepReal(Number(mc.eastings) || 0);
+                    const northings = toStepReal(Number(mc.northings) || 0);
+                    const height = toStepReal(Number(mc.orthogonalHeight) || 0);
+                    const abscissa = mc.xAxisAbscissa !== undefined ? toStepReal(Number(mc.xAxisAbscissa)) : '$';
+                    const ordinate = mc.xAxisOrdinate !== undefined ? toStepReal(Number(mc.xAxisOrdinate)) : '$';
+                    const scale = mc.scale !== undefined ? toStepReal(Number(mc.scale)) : '$';
                     newGeorefLines.push(`#${mcId}=IFCMAPCONVERSION(#${contextId},#${existingCrsIds[0]},${eastings},${northings},${height},${abscissa},${ordinate},${scale});`);
                     newEntityCount++;
                 }
@@ -329,8 +332,18 @@ export class StepExporter {
                 }
             }
         }
-        // If delta only, only export modified entities
-        if (options.deltaOnly && modifiedEntities.size === 0) {
+        // If delta only, only export modified entities. Overlay-created entities
+        // also count — without this, `createEntity()`-only edits would silently
+        // drop out of delta exports.
+        const overlayNewEntityCount = (this.mutationView
+            && options.applyMutations !== false
+            && typeof this.mutationView.getNewEntities === 'function') ? this.mutationView.getNewEntities().length : 0;
+        // Georef-only deltas (newGeorefLines populated but no entity changes) must
+        // still produce a non-empty DATA section.
+        if (options.deltaOnly
+            && modifiedEntities.size === 0
+            && overlayNewEntityCount === 0
+            && newGeorefLines.length === 0) {
             const emptyContent = new TextEncoder().encode(header + 'DATA;\nENDSEC;\nEND-ISO-10303-21;\n');
             return {
                 content: emptyContent,
@@ -357,7 +370,16 @@ export class StepExporter {
             const decoder = new TextDecoder();
             const source = this.dataStore.source;
             // Extract existing entities from source
+            const overlayActive = !!this.mutationView && (options.applyMutations !== false);
             for (const [expressId, entityRef] of this.dataStore.entityIndex.byId) {
+                // Skip entities deleted via the overlay (only when mutations are applied)
+                if (overlayActive && typeof this.mutationView.isDeleted === 'function' && this.mutationView.isDeleted(expressId)) {
+                    continue;
+                }
+                // Skip overlay-only entities — emitted by the new-entities pass below
+                if (entityRef.byteLength === 0 || entityRef.byteOffset < 0) {
+                    continue;
+                }
                 // Skip entities outside the visible closure
                 if (allowedEntityIds !== null && !allowedEntityIds.has(expressId)) {
                     continue;
@@ -378,9 +400,19 @@ export class StepExporter {
                 }
                 // Get original entity text
                 const entityText = decoder.decode(source.subarray(entityRef.byteOffset, entityRef.byteOffset + entityRef.byteLength));
-                const nextEntityText = modifiedAttributes.has(expressId)
+                let nextEntityText = modifiedAttributes.has(expressId)
                     ? this.applyAttributeMutations(entityText, entityType, modifiedAttributes.get(expressId))
                     : entityText;
+                const positional = overlayActive && typeof this.mutationView.getPositionalMutationsForEntity === 'function'
+                    ? this.mutationView.getPositionalMutationsForEntity(expressId)
+                    : null;
+                if (positional && positional.size > 0) {
+                    nextEntityText = this.applyPositionalMutations(nextEntityText, positional);
+                    if (!modifiedEntities.has(expressId)) {
+                        modifiedEntities.add(expressId);
+                        modifiedEntityCount++;
+                    }
+                }
                 // Apply schema conversion if exporting to a different schema version
                 if (converting) {
                     const converted = convertStepLine(nextEntityText, sourceSchema, schema);
@@ -429,6 +461,39 @@ export class StepExporter {
         for (const line of newGeorefLines) {
             entities.push(line);
         }
+        // Add overlay-created entities (store.addEntity / mutationView.createEntity).
+        // Apply the same filters as the source-iteration pass so newly-created
+        // beams/slabs don't smuggle their geometry helpers (IfcCartesianPoint,
+        // IfcExtrudedAreaSolid, etc.) past `includeGeometry:false` /
+        // `exportPropertiesOnly()` modes.
+        if (this.mutationView
+            && (options.applyMutations !== false)
+            && typeof this.mutationView.getNewEntities === 'function') {
+            for (const entity of this.mutationView.getNewEntities()) {
+                // STEP requires UPPERCASE entity type tokens. `NewEntity.type` is
+                // stored in canonical PascalCase per the public API contract; the
+                // upper-case happens here at the file-format boundary.
+                const upperType = entity.type.toUpperCase();
+                if (options.includeGeometry === false && this.isGeometryEntity(upperType)) {
+                    continue;
+                }
+                if (allowedEntityIds !== null && !allowedEntityIds.has(entity.expressId)) {
+                    continue;
+                }
+                const line = `#${entity.expressId}=${upperType}(${serializeStepArgs(entity.attributes)});`;
+                if (converting) {
+                    const converted = convertStepLine(line, sourceSchema, schema);
+                    if (converted !== null) {
+                        entities.push(converted);
+                        newEntityCount++;
+                    }
+                }
+                else {
+                    entities.push(line);
+                    newEntityCount++;
+                }
+            }
+        }
         // Assemble final file as Uint8Array chunks to avoid V8 string length limit
         const content = assembleStepBytes(header, entities);
         return {
@@ -486,11 +551,11 @@ export class StepExporter {
             for (const prop of pset.properties) {
                 const propId = this.nextExpressId++;
                 count++;
-                const valueStr = this.serializePropertyValue(prop.value, prop.type);
+                const valueStr = serializePropertyValue(prop.value, prop.type);
                 const unitId = prop.unit ? this.findUnitId(prop.unit) : null;
                 const unitStr = unitId !== null ? ref(unitId) : null;
                 // #ID=IFCPROPERTYSINGLEVALUE('Name',$,Value,Unit);
-                const line = `#${propId}=IFCPROPERTYSINGLEVALUE('${this.escapeStepString(prop.name)}',$,${valueStr},${unitStr ? serializeValue(unitStr) : '$'});`;
+                const line = `#${propId}=IFCPROPERTYSINGLEVALUE('${escapeStepString(prop.name)}',$,${valueStr},${unitStr ? serializeValue(unitStr) : '$'});`;
                 lines.push(line);
                 propertyIds.push(propId);
             }
@@ -500,7 +565,7 @@ export class StepExporter {
             const propRefs = propertyIds.map(id => `#${id}`).join(',');
             const globalId = this.generateGlobalId();
             // #ID=IFCPROPERTYSET('GlobalId',$,'Name',$,(#props));
-            const psetLine = `#${psetId}=IFCPROPERTYSET('${globalId}',$,'${this.escapeStepString(pset.name)}',$,(${propRefs}));`;
+            const psetLine = `#${psetId}=IFCPROPERTYSET('${globalId}',$,'${escapeStepString(pset.name)}',$,(${propRefs}));`;
             lines.push(psetLine);
             if (typeOwnedPsetNames?.has(pset.name)) {
                 generatedTypeOwnedPsetIds.set(pset.name, psetId);
@@ -528,10 +593,10 @@ export class StepExporter {
             for (const q of qset.quantities) {
                 const qId = this.nextExpressId++;
                 count++;
-                const ifcType = this.quantityTypeToIfcType(q.type);
+                const ifcType = quantityTypeToIfcType(q.type);
                 // #ID=IFCQUANTITYLENGTH('Name',$,$,Value,$);
-                const val = this.toStepReal(q.value);
-                const line = `#${qId}=${ifcType}('${this.escapeStepString(q.name)}',$,$,${val},$);`;
+                const val = toStepReal(q.value);
+                const line = `#${qId}=${ifcType}('${escapeStepString(q.name)}',$,$,${val},$);`;
                 lines.push(line);
                 quantityIds.push(qId);
             }
@@ -541,7 +606,7 @@ export class StepExporter {
             const quantRefs = quantityIds.map(id => `#${id}`).join(',');
             const globalId = this.generateGlobalId();
             // #ID=IFCELEMENTQUANTITY('GlobalId',$,'Name',$,$,(#quants));
-            const qsetLine = `#${qsetId}=IFCELEMENTQUANTITY('${globalId}',$,'${this.escapeStepString(qset.name)}',$,$,(${quantRefs}));`;
+            const qsetLine = `#${qsetId}=IFCELEMENTQUANTITY('${globalId}',$,'${escapeStepString(qset.name)}',$,$,(${quantRefs}));`;
             lines.push(qsetLine);
             // Create IfcRelDefinesByProperties to link qset to entity
             const relId = this.nextExpressId++;
@@ -552,60 +617,6 @@ export class StepExporter {
         }
         return { lines, count };
     }
-    /**
-     * Map QuantityType to IFC STEP entity type
-     */
-    quantityTypeToIfcType(type) {
-        switch (type) {
-            case QuantityType.Length: return 'IFCQUANTITYLENGTH';
-            case QuantityType.Area: return 'IFCQUANTITYAREA';
-            case QuantityType.Volume: return 'IFCQUANTITYVOLUME';
-            case QuantityType.Count: return 'IFCQUANTITYCOUNT';
-            case QuantityType.Weight: return 'IFCQUANTITYWEIGHT';
-            case QuantityType.Time: return 'IFCQUANTITYTIME';
-            default: return 'IFCQUANTITYCOUNT';
-        }
-    }
-    /**
-     * Serialize a property value to STEP format
-     */
-    serializePropertyValue(value, type) {
-        if (value === null || value === undefined) {
-            return '$';
-        }
-        switch (type) {
-            case PropertyValueType.String:
-            case PropertyValueType.Label:
-            case PropertyValueType.Text:
-                return `IFCLABEL('${this.escapeStepString(String(value))}')`;
-            case PropertyValueType.Identifier:
-                return `IFCIDENTIFIER('${this.escapeStepString(String(value))}')`;
-            case PropertyValueType.Real:
-                const num = Number(value);
-                if (!Number.isFinite(num))
-                    return '$';
-                return `IFCREAL(${num.toString().includes('.') ? num : num + '.'})`;
-            case PropertyValueType.Integer:
-                return `IFCINTEGER(${Math.round(Number(value))})`;
-            case PropertyValueType.Boolean:
-            case PropertyValueType.Logical:
-                if (value === true)
-                    return `IFCBOOLEAN(.T.)`;
-                if (value === false)
-                    return `IFCBOOLEAN(.F.)`;
-                return `IFCLOGICAL(.U.)`;
-            case PropertyValueType.Enum:
-                return `.${String(value).toUpperCase()}.`;
-            case PropertyValueType.List:
-                if (Array.isArray(value)) {
-                    const items = value.map(v => this.serializePropertyValue(v, PropertyValueType.String));
-                    return `(${items.join(',')})`;
-                }
-                return '$';
-            default:
-                return `IFCLABEL('${this.escapeStepString(String(value))}')`;
-        }
-    }
     /**
      * Rewrite root IFC attributes directly on the original STEP entity line.
      */
@@ -619,13 +630,13 @@ export class StepExporter {
         if (attrNames.length === 0) {
             return entityText;
         }
-        const args = this.splitTopLevelArgs(entityText.slice(openParen + 1, closeParen));
+        const args = splitTopLevelArgs(entityText.slice(openParen + 1, closeParen));
         let changed = false;
         for (const [attrName, value] of attributeMutations) {
             const index = attrNames.indexOf(attrName);
             if (index < 0 || index >= args.length)
                 continue;
-            args[index] = this.serializeAttributeValue(value, args[index]);
+            args[index] = serializeAttributeValue(value, args[index]);
             changed = true;
         }
         if (!changed) {
@@ -633,77 +644,28 @@ export class StepExporter {
         }
         return `${entityText.slice(0, openParen + 1)}${args.join(',')}${entityText.slice(closeParen)}`;
     }
-    serializeAttributeValue(value, currentToken) {
-        const trimmed = value.trim();
-        const current = currentToken.trim();
-        if (value === '')
-            return '$';
-        if (trimmed === '$' || trimmed === '*')
-            return trimmed;
-        if (/^#\d+$/.test(trimmed))
-            return trimmed;
-        if (/^\.[A-Z0-9_]+\.$/i.test(current) || /^\.[A-Z0-9_]+\.$/i.test(trimmed)) {
-            return `.${trimmed.replace(/^\./, '').replace(/\.$/, '').toUpperCase()}.`;
-        }
-        if (/^(?:\.T\.|\.F\.|\.U\.)$/i.test(current)) {
-            const normalized = trimmed.toLowerCase();
-            if (normalized === 'true' || normalized === '.t.')
-                return '.T.';
-            if (normalized === 'false' || normalized === '.f.')
-                return '.F.';
-            return '.U.';
-        }
-        if (/^-?\d+(?:\.\d+)?(?:E[+-]?\d+)?$/i.test(trimmed) && /^-?\d/.test(current)) {
-            const numberValue = Number(trimmed);
-            if (!Number.isFinite(numberValue))
-                return '$';
-            return current.includes('.') || /E/i.test(current)
-                ? this.toStepReal(numberValue)
-                : String(numberValue);
-        }
-        return serializeValue(value);
-    }
-    splitTopLevelArgs(text) {
-        const parts = [];
-        let current = '';
-        let depth = 0;
-        let inString = false;
-        for (let i = 0; i < text.length; i++) {
-            const char = text[i];
-            current += char;
-            if (inString) {
-                if (char === '\'') {
-                    if (text[i + 1] === '\'') {
-                        current += text[i + 1];
-                        i++;
-                    }
-                    else {
-                        inString = false;
-                    }
-                }
-                continue;
-            }
-            if (char === '\'') {
-                inString = true;
-                continue;
-            }
-            if (char === '(') {
-                depth++;
-                continue;
-            }
-            if (char === ')') {
-                depth--;
+    /**
+     * Apply positional STEP argument overrides to an entity line.
+     * Used for non-IfcRoot edits (e.g. profile dimensions) where attributes
+     * have no symbolic names. Indexes that fall outside the existing arg list
+     * are silently ignored.
+     */
+    applyPositionalMutations(entityText, positionals) {
+        const openParen = entityText.indexOf('(');
+        const closeParen = entityText.lastIndexOf(');');
+        if (openParen < 0 || closeParen < openParen)
+            return entityText;
+        const args = splitTopLevelArgs(entityText.slice(openParen + 1, closeParen));
+        let changed = false;
+        for (const [index, value] of positionals) {
+            if (index < 0 || index >= args.length)
                 continue;
-            }
-            if (char === ',' && depth === 0) {
-                parts.push(current.slice(0, -1).trim());
-                current = '';
-            }
-        }
-        if (current.trim() || text.endsWith(',')) {
-            parts.push(current.trim());
+            args[index] = serializeStepValue(value);
+            changed = true;
         }
-        return parts;
+        if (!changed)
+            return entityText;
+        return `${entityText.slice(0, openParen + 1)}${args.join(',')}${entityText.slice(closeParen)}`;
     }
     resolveMapUnitReference(unitName, newGeorefLines) {
         const normalized = this.normalizeMapUnitName(unitName);
@@ -725,7 +687,7 @@ export class StepExporter {
             const name = normalized === 'US SURVEY FOOT' ? 'US SURVEY FOOT' : 'FOOT';
             newGeorefLines.push(`#${dimId}=IFCDIMENSIONALEXPONENTS(1,0,0,0,0,0,0);`);
             newGeorefLines.push(`#${siUnitId}=IFCSIUNIT(*,.LENGTHUNIT.,$,.METRE.);`);
-            newGeorefLines.push(`#${measureId}=IFCMEASUREWITHUNIT(IFCLENGTHMEASURE(${this.toStepReal(factor)}),#${siUnitId});`);
+            newGeorefLines.push(`#${measureId}=IFCMEASUREWITHUNIT(IFCLENGTHMEASURE(${toStepReal(factor)}),#${siUnitId});`);
             newGeorefLines.push(`#${convUnitId}=IFCCONVERSIONBASEDUNIT(#${dimId},.LENGTHUNIT.,'${name}',#${measureId});`);
             return convUnitId;
         }
@@ -808,24 +770,6 @@ export class StepExporter {
         }
         return first3dContext ?? contextIds[0] ?? null;
     }
-    /**
-     * Convert a number to a valid STEP REAL literal.
-     * Handles NaN/Infinity (→ 0.) and ensures a decimal point is present.
-     */
-    toStepReal(v) {
-        if (!Number.isFinite(v))
-            return '0.';
-        const s = v.toString();
-        return s.includes('.') ? s : s + '.';
-    }
-    /**
-     * Escape a string for STEP format
-     */
-    escapeStepString(str) {
-        return str
-            .replace(/\\/g, '\\\\')
-            .replace(/'/g, "''");
-    }
     /**
      * Generate a new IFC GlobalId (22 character base64)
      */
@@ -1040,48 +984,12 @@ export class StepExporter {
         if (!match)
             return null;
         const [, prefix, attrsText, suffix] = match;
-        const attrs = this.splitTopLevelStepArguments(attrsText);
+        const attrs = splitTopLevelStepArguments(attrsText);
         if (attrIndex >= attrs.length)
             return null;
         attrs[attrIndex] = replacement;
         return `${prefix}${attrs.join(',')}${suffix}`;
     }
-    /**
-     * Split a STEP argument list on top-level commas while preserving nested syntax.
-     */
-    splitTopLevelStepArguments(input) {
-        const parts = [];
-        let current = '';
-        let depth = 0;
-        let inString = false;
-        for (let i = 0; i < input.length; i++) {
-            const char = input[i];
-            if (char === "'") {
-                current += char;
-                if (inString && i + 1 < input.length && input[i + 1] === "'") {
-                    current += input[i + 1];
-                    i++;
-                    continue;
-                }
-                inString = !inString;
-                continue;
-            }
-            if (!inString) {
-                if (char === '(')
-                    depth++;
-                else if (char === ')')
-                    depth--;
-                else if (char === ',' && depth === 0) {
-                    parts.push(current);
-                    current = '';
-                    continue;
-                }
-            }
-            current += char;
-        }
-        parts.push(current);
-        return parts;
-    }
 }
 /**
  * Quick export function for simple use cases.