@ifc-lite/create 2.4.0 → 2.6.0

package/dist/ifc-creator.js

@@ -1,28 +1,12 @@
 /* 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/. */
-import { esc, stepLine, num, vecLen, vecNorm, vecCross, NON_ELEMENT_TYPES, assertPositiveFinite, assertFinitePoint3, } from './ifc-creator-math.js';
+import { esc, stepLine, num, vecLen, vecNorm, vecCross, optStr, optEnum, NON_ELEMENT_TYPES, assertPositiveFinite, assertFinitePoint3, } from './ifc-creator-math.js';
+import { emitWorkCalendar, emitTaskTime } from './ifc-creator-scheduling.js';
+import { assertCostSchema, emitCostItem, emitCostSchedule, emitCostValue, emitMeasureWithUnit, emitMonetaryUnit, emitPhysicalQuantity, emitRelAssignsToProduct, emitSIUnit, } from './ifc-creator-cost.js';
+import { emitElementQuantity, emitPropertySet } from './ifc-creator-definitions.js';
 import { generateIfcGuid, isValidIfcGuid } from '@ifc-lite/encoding';
 // ============================================================================
-// STEP attribute helpers (scheduling — optional strings / enums / numbers)
-// ============================================================================
-/** Emit an optional STEP string: `'value'` when present, `$` otherwise. */
-function optStr(v) {
-    return v === undefined || v === null || v === '' ? '$' : `'${esc(v)}'`;
-}
-/** Emit an optional STEP enum: `.VALUE.` when present, `$` otherwise. */
-function optEnum(v) {
-    return v === undefined || v === null || v === '' ? '$' : `.${v}.`;
-}
-/** Emit an optional STEP boolean: `.T.`/`.F.`/`$`. */
-function optBool(v) {
-    return v === undefined || v === null ? '$' : v ? '.T.' : '.F.';
-}
-/** Emit an optional STEP real number; `$` when absent. */
-function optReal(v) {
-    return v === undefined || v === null || !Number.isFinite(v) ? '$' : num(v);
-}
-// ============================================================================
 // IfcCreator
 // ============================================================================
 /**
@@ -854,7 +838,6 @@ export class IfcCreator {
         const name = params.Name ?? 'Space';
         const desc = params.Description ? `'${esc(params.Description)}'` : '$';
         const objType = params.ObjectType ? `'${esc(params.ObjectType)}'` : '$';
-        const tag = params.Tag ? `'${esc(params.Tag)}'` : '$';
         const longName = params.LongName ? `'${esc(params.LongName)}'` : '$';
         this.line(spaceId, 'IFCSPACE', `'${globalId}',#${this.ownerHistoryId},'${esc(name)}',${desc},${objType},#${placementId},#${prodShapeId},${longName},.ELEMENT.,.INTERNAL.,$`);
         this.elementSolids.set(spaceId, [solidId]);
@@ -1198,39 +1181,16 @@ export class IfcCreator {
     // ============================================================================
     /** Attach a property set to an element */
     addIfcPropertySet(elementId, pset) {
-        const propIds = [];
-        for (const prop of pset.Properties) {
-            const propId = this.id();
-            const valueStr = this.serializePropertyValue(prop);
-            this.line(propId, 'IFCPROPERTYSINGLEVALUE', `'${esc(prop.Name)}',$,${valueStr},$`);
-            propIds.push(propId);
-        }
-        const psetId = this.id();
-        const globalId = this.newGlobalId();
-        const refs = propIds.map(id => `#${id}`).join(',');
-        this.line(psetId, 'IFCPROPERTYSET', `'${globalId}',#${this.ownerHistoryId},'${esc(pset.Name)}',$,(${refs})`);
-        const relId = this.id();
-        const relGlobalId = this.newGlobalId();
-        this.line(relId, 'IFCRELDEFINESBYPROPERTIES', `'${relGlobalId}',#${this.ownerHistoryId},$,$,(#${elementId}),#${psetId}`);
-        return psetId;
+        return emitPropertySet(elementId, pset, this.definitionContext());
     }
     /** Attach element quantities to an element */
     addIfcElementQuantity(elementId, qset) {
-        const qtyIds = [];
-        for (const qty of qset.Quantities) {
-            const qtyId = this.id();
-            const valueField = this.quantityValueField(qty);
-            this.line(qtyId, qty.Kind.toUpperCase(), `'${esc(qty.Name)}',$,${valueField}${this.ifc4Only('$')}`);
-            qtyIds.push(qtyId);
-        }
-        const qsetId = this.id();
-        const globalId = this.newGlobalId();
-        const refs = qtyIds.map(id => `#${id}`).join(',');
-        this.line(qsetId, 'IFCELEMENTQUANTITY', `'${globalId}',#${this.ownerHistoryId},'${esc(qset.Name)}',$,$,(${refs})`);
-        const relId = this.id();
-        const relGlobalId = this.newGlobalId();
-        this.line(relId, 'IFCRELDEFINESBYPROPERTIES', `'${relGlobalId}',#${this.ownerHistoryId},$,$,(#${elementId}),#${qsetId}`);
-        return qsetId;
+        return emitElementQuantity(elementId, qset, this.definitionContext());
+    }
+    /** The creator hooks `ifc-creator-definitions.ts`'s emitters need. */
+    definitionContext() {
+        return { emit: this.emitEntity, newGlobalId: () => this.newGlobalId(),
+            ownerRef: `#${this.ownerHistoryId}`, ifc4Only: (v) => this.ifc4Only(v) };
     }
     // ============================================================================
     // Public API — Styling
@@ -1283,7 +1243,7 @@ export class IfcCreator {
         this.elementMaterials.set(elementId, materialRefId);
     }
     // ============================================================================
-    // Public API — Scheduling / 4D  (IfcWorkSchedule, IfcTask, IfcRelSequence)
+    // Public API — Scheduling / 4D  (IfcWorkSchedule, IfcTask, IfcRelSequence, IfcWorkCalendar)
     // ============================================================================
     /**
      * Create an IfcWorkSchedule. Returns its expressId for assigning tasks
@@ -1299,6 +1259,32 @@ export class IfcCreator {
     addIfcWorkPlan(params) {
         return this.buildWorkControl('IFCWORKPLAN', params);
     }
+    /**
+     * Create an IfcWorkCalendar — the working / non-working time calendar an
+     * IfcTask or IfcWorkSchedule can be assigned to. `WorkingTimes` /
+     * `ExceptionTimes` entries become nested IfcWorkTime entities (with their
+     * IfcRecurrencePattern / IfcTimePeriod when the entry carries a
+     * recurrence), the same way `addIfcTask` emits its IfcTaskTime. Assign it
+     * with `assignCalendarToTasks`. Returns the calendar expressId.
+     */
+    addIfcWorkCalendar(params) {
+        if (this.schema === 'IFC2X3') {
+            throw new Error('addIfcWorkCalendar is not supported for IFC2X3');
+        }
+        const id = emitWorkCalendar(params, this.newGlobalId(), `#${this.ownerHistoryId}`, this.emitEntity);
+        this.entities.push({ expressId: id, type: 'IfcWorkCalendar', Name: params.Name });
+        return id;
+    }
+    /**
+     * Allocate an express id, write its STEP line, and hand the id back — the
+     * one hook `ifc-creator-scheduling.ts`'s emitters need from the creator.
+     * An arrow property so it can be passed by reference without binding.
+     */
+    emitEntity = (type, attrs) => {
+        const entityId = this.id();
+        this.line(entityId, type, attrs);
+        return entityId;
+    };
     /**
      * Create an IfcTask. If any Schedule/Actual/Early/Late time field, IsCritical,
      * or Completion attribute is present, an IfcTaskTime is created and linked.
@@ -1322,7 +1308,7 @@ export class IfcCreator {
             params.IsCritical !== undefined ||
             params.DurationType !== undefined ||
             params.Completion !== undefined;
-        const taskTimeId = hasTaskTime ? this.addIfcTaskTime(params) : 0;
+        const taskTimeId = hasTaskTime ? emitTaskTime(params, this.emitEntity) : 0;
         const taskId = this.id();
         const globalId = this.newGlobalId();
         const name = params.Name;
@@ -1340,43 +1326,6 @@ export class IfcCreator {
         this.entities.push({ expressId: taskId, type: 'IfcTask', Name: name });
         return taskId;
     }
-    /**
-     * Build an IfcTaskTime from the task params (internal helper — prefer
-     * setting the time fields on the task itself via `addIfcTask`).
-     */
-    addIfcTaskTime(params) {
-        const ttId = this.id();
-        // [0] Name, [1] DataOrigin, [2] UserDefinedDataOrigin,
-        // [3] DurationType, [4] ScheduleDuration, [5] ScheduleStart, [6] ScheduleFinish,
-        // [7..10] Early/Late Start/Finish, [11] FreeFloat, [12] TotalFloat,
-        // [13] IsCritical, [14] StatusTime,
-        // [15] ActualDuration, [16] ActualStart, [17] ActualFinish,
-        // [18] RemainingTime, [19] Completion
-        const attrs = [
-            '$', // Name
-            '$', // DataOrigin
-            '$', // UserDefinedDataOrigin
-            optEnum(params.DurationType), // DurationType
-            optStr(params.ScheduleDuration), // ScheduleDuration
-            optStr(params.ScheduleStart), // ScheduleStart
-            optStr(params.ScheduleFinish), // ScheduleFinish
-            optStr(params.EarlyStart), // EarlyStart
-            optStr(params.EarlyFinish), // EarlyFinish
-            optStr(params.LateStart), // LateStart
-            optStr(params.LateFinish), // LateFinish
-            optStr(params.FreeFloat), // FreeFloat
-            optStr(params.TotalFloat), // TotalFloat
-            optBool(params.IsCritical), // IsCritical
-            optStr(params.StatusTime), // StatusTime
-            optStr(params.ActualDuration), // ActualDuration
-            optStr(params.ActualStart), // ActualStart
-            optStr(params.ActualFinish), // ActualFinish
-            optStr(params.RemainingTime), // RemainingTime
-            optReal(params.Completion), // Completion
-        ];
-        this.line(ttId, 'IFCTASKTIME', attrs.join(','));
-        return ttId;
-    }
     /**
      * Create an IfcRelSequence between two tasks. The predecessor is `RelatingProcess`
      * and the successor is `RelatedProcess`. SequenceType defaults to FINISH_START.
@@ -1427,6 +1376,15 @@ export class IfcCreator {
     assignSchedulesToWorkPlan(planId, scheduleIds) {
         return this.addIfcRelAssignsToControl(planId, scheduleIds);
     }
+    /**
+     * Ergonomic alias — assign an IfcWorkCalendar to tasks (or work
+     * schedules; same relation either way). Delegates to
+     * {@link addIfcRelAssignsToControl}, which accepts a calendar because
+     * IfcWorkCalendar is an IfcControl.
+     */
+    assignCalendarToTasks(calendarId, taskIds) {
+        return this.addIfcRelAssignsToControl(calendarId, taskIds);
+    }
     /**
      * Emit an IfcRelAssignsToProcess — binds products (walls, slabs, ...) to an
      * IfcProcess (usually an IfcTask). These drive the Gantt 4D animation.
@@ -1462,6 +1420,68 @@ export class IfcCreator {
     nestTasks(parentTaskId, childTaskIds) {
         return this.addIfcRelNests(parentTaskId, childTaskIds);
     }
+    // Public API — Cost / 5D. Every method delegates to `ifc-creator-cost.ts` and refuses
+    // IFC2X3 by name (its cost entity layout differs, so IFC4 records would parse and mislead).
+    /** Create an IfcCostSchedule (IFC4 / IFC4X3 only). Returns its expressId. */
+    addIfcCostSchedule(params) {
+        assertCostSchema(this.schema, 'addIfcCostSchedule');
+        const id = emitCostSchedule(params, this.newGlobalId(), `#${this.ownerHistoryId}`, this.emitEntity);
+        this.entities.push({ expressId: id, type: 'IfcCostSchedule', Name: params.Name });
+        return id;
+    }
+    /** Create an IfcCostItem (IFC4 / IFC4X3 only). Returns its expressId. */
+    addIfcCostItem(params) {
+        assertCostSchema(this.schema, 'addIfcCostItem');
+        const id = emitCostItem(params, this.newGlobalId(), `#${this.ownerHistoryId}`, this.emitEntity);
+        this.entities.push({ expressId: id, type: 'IfcCostItem', Name: params.Name });
+        return id;
+    }
+    /** Create an IfcCostValue (IFC4 / IFC4X3 only). Returns its expressId. */
+    addIfcCostValue(params) {
+        assertCostSchema(this.schema, 'addIfcCostValue');
+        const id = emitCostValue(params, this.schema, this.emitEntity);
+        this.entities.push({ expressId: id, type: 'IfcCostValue', Name: params.Name });
+        return id;
+    }
+    /** Create an IfcMonetaryUnit for `currency`. No default — omit it to leave the currency unstated. */
+    addIfcMonetaryUnit(currency) {
+        assertCostSchema(this.schema, 'addIfcMonetaryUnit');
+        return emitMonetaryUnit(currency, this.emitEntity);
+    }
+    /** Create an IfcSIUnit, for use as an IfcMeasureWithUnit or quantity unit. */
+    addIfcSIUnit(params) {
+        assertCostSchema(this.schema, 'addIfcSIUnit');
+        return emitSIUnit(params, this.emitEntity);
+    }
+    /** Create an IfcMeasureWithUnit — what a UnitBasis or entity-valued AppliedValue points at. */
+    addIfcMeasureWithUnit(value, unitId) {
+        assertCostSchema(this.schema, 'addIfcMeasureWithUnit');
+        return emitMeasureWithUnit(value, unitId, this.schema, this.emitEntity);
+    }
+    /** Create a standalone IfcPhysicalSimpleQuantity for IfcCostItem.CostQuantities. */
+    addIfcPhysicalQuantity(params) {
+        assertCostSchema(this.schema, 'addIfcPhysicalQuantity');
+        return emitPhysicalQuantity(params, this.schema, this.emitEntity);
+    }
+    /** Emit an IfcRelAssignsToProduct — see {@link emitRelAssignsToProduct} for the direction rule. */
+    addIfcRelAssignsToProduct(relatingProductId, relatedObjectIds) {
+        return emitRelAssignsToProduct(relatingProductId, relatedObjectIds, () => this.newGlobalId(), `#${this.ownerHistoryId}`, this.emitEntity);
+    }
+    // Ergonomic aliases over the canonical relationships: cost items under a
+    // schedule, cost items pricing a product, tasks bound to a cost item (an
+    // IfcCostItem is an IfcControl), and the cost breakdown hierarchy.
+    assignCostItemsToSchedule(scheduleId, costItemIds) {
+        return this.addIfcRelAssignsToControl(scheduleId, costItemIds);
+    }
+    assignCostItemsToProduct(productId, costItemIds) {
+        return this.addIfcRelAssignsToProduct(productId, costItemIds);
+    }
+    assignTasksToCostItem(costItemId, taskIds) {
+        return this.addIfcRelAssignsToControl(costItemId, taskIds);
+    }
+    nestCostItems(parentCostItemId, childCostItemIds) {
+        return this.addIfcRelNests(parentCostItemId, childCostItemIds);
+    }
     /**
      * Internal — emit an IfcWorkSchedule or IfcWorkPlan (identical attribute
      * layout). Separate helpers are exposed publicly for ergonomics.
@@ -1559,7 +1579,7 @@ ENDSEC;
         this.subContextAxis = this.id();
         this.line(this.subContextAxis, 'IFCGEOMETRICREPRESENTATIONSUBCONTEXT', `$,'Axis',*,*,*,*,#${this.contextId},$,.GRAPH_VIEW.,$`);
         // Units
-        this.unitAssignmentId = this.buildUnits(params.LengthUnit ?? 'METRE');
+        this.unitAssignmentId = this.buildUnits(params.LengthUnit ?? 'METRE', params.Currency);
         // Default surface style — light grey with some specularity
         this.defaultStyleId = this.buildDefaultStyle();
         // IfcProject
@@ -1580,7 +1600,7 @@ ENDSEC;
         this.line(this.buildingId, 'IFCBUILDING', `'${buildingGlobalId}',#${this.ownerHistoryId},'Building',$,$,#${this.worldPlacementId},$,$,.ELEMENT.,$,$,$`);
         this.entities.push({ expressId: this.buildingId, type: 'IfcBuilding', Name: 'Building' });
     }
-    buildUnits(lengthUnit) {
+    buildUnits(lengthUnit, currency) {
         const dimExpId = this.id();
         this.line(dimExpId, 'IFCDIMENSIONALEXPONENTS', '0,0,0,0,0,0,0');
         const siLengthId = this.id();
@@ -1597,8 +1617,15 @@ ENDSEC;
         this.line(siVolumeId, 'IFCSIUNIT', `*,.VOLUMEUNIT.,$,.CUBIC_METRE.`);
         const siAngleId = this.id();
         this.line(siAngleId, 'IFCSIUNIT', `*,.PLANEANGLEUNIT.,$,.RADIAN.`);
+        // Absent currency stays absent: no IfcMonetaryUnit is written at all, so
+        // the cost read model reports no project currency rather than a guess.
+        const units = [lengthUnitId, siAreaId, siVolumeId, siAngleId];
+        if (currency !== undefined) {
+            assertCostSchema(this.schema, 'ProjectParams.Currency'); // IFC2X3 Currency is an enum
+            units.push(emitMonetaryUnit(currency, this.emitEntity));
+        }
         const assignmentId = this.id();
-        this.line(assignmentId, 'IFCUNITASSIGNMENT', `(#${lengthUnitId},#${siAreaId},#${siVolumeId},#${siAngleId})`);
+        this.line(assignmentId, 'IFCUNITASSIGNMENT', `(${units.map(id => `#${id}`).join(',')})`);
         return assignmentId;
     }
     /** Create a default IfcSurfaceStyle with a neutral colour (RGB 0.75, 0.73, 0.68) */
@@ -2138,40 +2165,8 @@ ENDSEC;
         this.entities.push({ expressId: openingId, type: 'IfcOpeningElement', Name: name });
         return openingId;
     }
-    // ============================================================================
-    // Internal — Property/quantity serialization
-    // ============================================================================
-    serializePropertyValue(prop) {
-        const val = prop.NominalValue;
-        if (typeof val === 'string') {
-            const typeName = prop.Type ?? 'IfcLabel';
-            return `${typeName.toUpperCase()}('${esc(val)}')`;
-        }
-        if (typeof val === 'number') {
-            const typeName = prop.Type ?? (Number.isInteger(val) ? 'IfcInteger' : 'IfcReal');
-            return typeName === 'IfcInteger' ? `IFCINTEGER(${Math.round(val)})` : `IFCREAL(${num(val)})`;
-        }
-        if (typeof val === 'boolean') {
-            // `Type: 'IfcLogical'` (tri-state) must not be downgraded to IFCBOOLEAN.
-            const typeName = prop.Type === 'IfcLogical' ? 'IFCLOGICAL' : 'IFCBOOLEAN';
-            return `${typeName}(${val ? '.T.' : '.F.'})`;
-        }
-        return '$';
-    }
+    // `serializePropertyValue` / `quantityValueField` moved to `ifc-creator-math.ts`.
     ifc4Only(v) { return this.schema === 'IFC2X3' ? '' : `,${v}`; } // trailing IFC4/4X3-only attribute
-    quantityValueField(qty) {
-        switch (qty.Kind) {
-            case 'IfcQuantityLength':
-            case 'IfcQuantityArea':
-            case 'IfcQuantityVolume':
-            case 'IfcQuantityWeight':
-                return `$,${num(qty.Value)}`;
-            case 'IfcQuantityCount':
-                return `$,${Math.round(qty.Value)}`;
-            default:
-                return `$,${num(qty.Value)}`;
-        }
-    }
     // ============================================================================
     // Internal — Relationship finalization
     // ============================================================================