@ifc-lite/export 2.9.4 → 3.0.1

package/dist/step-map-unit.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Map-unit resolution for the georeferencing phase: the `IfcNamedUnit` an
+ * `IfcProjectedCRS.MapUnit` points at, and the reuse-or-synthesise decision
+ * behind it.
+ *
+ * Split out of `step-georeferencing.ts` in #3274 rather than grown in place —
+ * the question it answers is a different one from "which georeferencing
+ * entities does this export write", it has a second caller in
+ * `step-property-sets.ts` (property units reach `findLengthUnitReference`
+ * through `findUnitId`), and the module-size budget is not a thing to raise.
+ *
+ * THE RULE THIS MODULE EXISTS TO KEEP: a unit name is compared WHOLE. The
+ * defect it was extracted for was a substring test — `normalized.includes('METRE')`
+ * — which `MILLIMETRE`, `CENTIMETRE` and `KILOMETRE` all satisfy, so every one
+ * of them was written into the file as a plain `.METRE.`. The map unit is the
+ * scale of the entire coordinate reference system, so that is a silent 1000x
+ * error in the one attribute another team uses to place the model on the
+ * earth, and it is invisible in the output: a millimetre request produced
+ * bytes identical to a metre request.
+ *
+ * And a unit this module cannot express is REFUSED, not approximated.
+ * `IfcProjectedCRS.MapUnit` is `OPTIONAL IfcNamedUnit` with
+ * `IsLengthUnit : NOT(EXISTS(MapUnit)) OR (MapUnit.UnitType = LENGTHUNIT)`, so
+ * an absent MapUnit is schema-valid; a MapUnit naming the wrong unit is not
+ * merely lossy, it is false, and nothing downstream can tell it from a true
+ * one.
+ */
+import type { EffectiveEntityIndex } from './effective-index.js';
+import type { GeorefContext, GeorefLookupContext } from './step-georeferencing.js';
+/**
+ * Message for the refusal when a requested map unit is one this exporter
+ * cannot express as an `IfcNamedUnit`. `MapUnit` is optional, so it is left
+ * absent rather than filled with a unit that is not the one asked for (#3274).
+ */
+export declare function mapUnitUnsupportedWarning(unitName: string): string;
+/** Record a map unit the exporter refused to guess at. */
+export declare function reportMapUnitUnsupported(warnings: string[], unitName: string): void;
+export declare function resolveMapUnitReference(unitName: string, newGeorefLines: string[], effective: EffectiveEntityIndex, ctx: GeorefContext): number | null;
+/**
+ * Canonicalize a map-unit label to the spelling the rest of this module
+ * compares against: American `METER` to `METRE`, the foot spellings to `FOOT`,
+ * the US survey foot to `US SURVEY FOOT`, and an SI prefix kept rather than
+ * swallowed. Anything not recognised is returned normalised-but-unchanged, for
+ * the caller to REFUSE rather than guess at.
+ *
+ * The label is NORMALISED and then matched EXACTLY — never substring-matched.
+ *
+ * What the normalisation accepts:
+ * - any case and any separators: `metres`, `Meters`, `MILLI-METRE`;
+ * - `METRE` and `METER`, each carrying any `IfcSIPrefix` member;
+ * - `FOOT` and `FEET`;
+ * - one English plural suffix, stripped once and re-matched exactly;
+ * - the US survey foot, glued or separated in any word order.
+ *
+ * What it REFUSES, by leaving the label alone so `resolveMapUnitReference`
+ * returns `null` and `MapUnit` stays `$` with a warning:
+ * - a label that merely CONTAINS a unit. `MILLIMETRE`, `CENTIMETRE` and
+ *   `KILOMETRE` all contain `METRE`, and an `includes('METRE')` test wrote all
+ *   three into the file as a plain `.METRE.` — a silent 1000x error in the CRS
+ *   scale (#3274). The foot half of that same test was `includes('FOOT')`, and
+ *   it was satisfied by `FOOTCANDLE` (an illuminance), `FOOT-POUND` (an
+ *   energy), `FOOTPRINT`, and by `SQUARE FOOT` and `CUBIC FEET` — an area and
+ *   a volume written as a LENGTH unit, which is a wrong DIMENSION rather than
+ *   a wrong magnitude, and no scale factor can be right for it;
+ * - a survey foot with no nationality: `SURVEY FOOT`, `CLARKE'S FOOT`,
+ *   `INDIAN FOOT`, `SEARS FOOT`, `BRITISH FOOT (1936)` are five different
+ *   ratios, and `includes('FOOT')` gave every one of them the international
+ *   0.3048;
+ * - `INCH`, `YARD`, `MILE` and anything else this exporter cannot express.
+ *
+ * Normalising a recognisable spelling onto a table entry is NOT that
+ * approximation: the answer is still one exact table hit, so `MILLIMETERS`
+ * resolves to `MILLIMETRE` and not to `METRE`.
+ *
+ * Sibling of `inferMapUnitScaleFromLabel` in
+ * packages/parser/src/map-unit-label.ts and `infer_map_unit_scale` in
+ * rust/core/src/unit_labels.rs, which apply these same rules on the reading
+ * side. This exporter's accepted set is the smaller one — it writes only what
+ * it can express as an `IfcNamedUnit` — but no spelling may be accepted here
+ * that those refuse, or refused here that those accept as a length.
+ */
+export declare function normalizeMapUnitName(unitName: string): string;
+/**
+ * `effective` filters the candidates the same way the georef reads above do:
+ * returning a tombstoned unit id hands the caller a `#id` for a line the
+ * export never writes. Returning null instead makes `resolveMapUnitReference`
+ * synthesise a fresh unit, which is the outcome a deleted unit deserves.
+ */
+export declare function findLengthUnitReference(preferredUnitName: string, effective: EffectiveEntityIndex, ctx: GeorefLookupContext): number | null;
+//# sourceMappingURL=step-map-unit.d.ts.map

package/dist/step-map-unit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-map-unit.d.ts","sourceRoot":"","sources":["../src/step-map-unit.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAEnF;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAElE;AAED,0DAA0D;AAC1D,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAInF;AAED,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,oBAAoB,EAAE,GAAG,EAAE,aAAa,GAAG,MAAM,GAAG,IAAI,CAwCtJ;AA8FD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAkB7D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,iBAAiB,EAAE,MAAM,EAAE,SAAS,EAAE,oBAAoB,EAAE,GAAG,EAAE,mBAAmB,GAAG,MAAM,GAAG,IAAI,CAwD3I"}

package/dist/step-map-unit.js

@@ -0,0 +1,277 @@
+/* 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 { toStepReal } from './step-serialization.js';
+/**
+ * Message for the refusal when a requested map unit is one this exporter
+ * cannot express as an `IfcNamedUnit`. `MapUnit` is optional, so it is left
+ * absent rather than filled with a unit that is not the one asked for (#3274).
+ */
+export function mapUnitUnsupportedWarning(unitName) {
+    return `Cannot express map unit ${JSON.stringify(unitName)} as an IfcNamedUnit: only metres (with any SI prefix), FOOT and US SURVEY FOOT are supported. IfcProjectedCRS.MapUnit was left unset rather than declared as metres.`;
+}
+/** Record a map unit the exporter refused to guess at. */
+export function reportMapUnitUnsupported(warnings, unitName) {
+    const message = mapUnitUnsupportedWarning(unitName);
+    warnings.push(message);
+    console.warn(`[StepExporter] ${message}`);
+}
+export function resolveMapUnitReference(unitName, newGeorefLines, effective, ctx) {
+    const normalized = normalizeMapUnitName(unitName);
+    const existing = findLengthUnitReference(normalized, effective, ctx);
+    if (existing !== null) {
+        return existing;
+    }
+    // A metre, with or without an SI prefix. `MILLIMETRE` KEEPS its prefix: the
+    // map unit is the scale of the entire coordinate reference system, so
+    // writing `.METRE.` for a millimetre map is a silent 1000x error in the one
+    // attribute another team relies on to place the model (#3274).
+    const prefix = siPrefixOf(normalized);
+    if (prefix !== undefined) {
+        const unitId = ctx.allocateExpressId();
+        const prefixToken = prefix === null ? '$' : `.${prefix}.`;
+        newGeorefLines.push(`#${unitId}=IFCSIUNIT(*,.LENGTHUNIT.,${prefixToken},.METRE.);`);
+        return unitId;
+    }
+    if (normalized === 'FOOT' || normalized === 'US SURVEY FOOT') {
+        const dimId = ctx.allocateExpressId();
+        const siUnitId = ctx.allocateExpressId();
+        const measureId = ctx.allocateExpressId();
+        const convUnitId = ctx.allocateExpressId();
+        const factor = normalized === 'US SURVEY FOOT' ? 1200 / 3937 : 0.3048;
+        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(${toStepReal(factor)}),#${siUnitId});`);
+        newGeorefLines.push(`#${convUnitId}=IFCCONVERSIONBASEDUNIT(#${dimId},.LENGTHUNIT.,'${name}',#${measureId});`);
+        return convUnitId;
+    }
+    // A unit this exporter cannot express. It must NOT claim to be metres: that
+    // is the coordinate reference system's scale, and a wrong one is worse than
+    // an absent one. `IfcProjectedCRS.MapUnit` is `OPTIONAL IfcNamedUnit`, and
+    // the WHERE rule is `NOT(EXISTS(MapUnit)) OR MapUnit.UnitType = LENGTHUNIT`,
+    // so omitting it is schema-valid. Refuse, and let the caller say so in
+    // `stats.warnings` the way the two map-conversion refusals do (#3274).
+    return null;
+}
+/** Every `IfcSIPrefix` member, longest first so `MILLI` cannot shadow `MILLIMICRO`-style
+ *  compounds and `DECA` cannot shadow `DECI`. */
+const SI_PREFIXES = [
+    'FEMTO', 'MICRO', 'HECTO', 'CENTI', 'MILLI',
+    'EXA', 'PETA', 'TERA', 'GIGA', 'MEGA', 'KILO', 'DECA', 'DECI', 'NANO', 'PICO', 'ATTO',
+];
+/**
+ * The `IfcSIPrefix` token for a normalized metre name — `null` for a bare
+ * `METRE`, the prefix for a prefixed one, and `undefined` when the name is not
+ * a metre at all.
+ *
+ * Three-valued deliberately: `null` and `undefined` are the two answers a bare
+ * boolean would merge, and merging them is the defect — `MILLIMETRE` reaching
+ * the "plain metre" arm is exactly what {@link normalizeMapUnitName}'s old
+ * `includes('METRE')` test did.
+ */
+function siPrefixOf(normalized) {
+    if (normalized === 'METRE')
+        return null;
+    for (const prefix of SI_PREFIXES) {
+        if (normalized === `${prefix}METRE`)
+            return prefix;
+    }
+    return undefined;
+}
+/** Split a map-unit label into upper-cased alphanumeric tokens. */
+function tokenizeUnitLabel(label) {
+    return label.toUpperCase().split(/[^A-Z0-9]+/).filter((token) => token.length > 0);
+}
+/** The foot/feet spellings a US-survey qualifier may be attached to. */
+const FOOT_TOKENS = new Set(['FOOT', 'FEET', 'FT']);
+/**
+ * Order-insensitive recogniser for the separated US-survey foot spellings —
+ * `foot (US survey)`, `SURVEY FEET (US)`, `US survey foot`. The glued
+ * spellings (`USSURVEYFOOT`, `FTUS`, …) are in {@link MAP_UNIT_CANONICAL_NAME}
+ * and matched exactly there; once an exporter puts separators in, the word
+ * order varies and gluing alone cannot see it.
+ *
+ * Accepts exactly one foot token plus either `US` (or the glued `USSURVEY`)
+ * or both `US` and `SURVEY`. A bare `SURVEY FOOT` without `US` is REFUSED:
+ * other national survey feet exist and are different ratios — Clarke's foot is
+ * 0.3047972654 m, the Indian foot 0.304799514 m — so the qualifier alone does
+ * not identify a value. `US FOOT` on its own IS accepted: EPSG 9003 is the
+ * only US foot, so the nationality does identify it.
+ *
+ * The requirement that exactly ONE foot token be present, with nothing else
+ * beside the qualifier, is what refuses `SQUARE US SURVEY FOOT` (an area) and
+ * `NON-US SURVEY FOOT` (a label that says it is not this unit).
+ *
+ * Sibling of `isUsSurveyFootTokens` in packages/parser/src/map-unit-label.ts
+ * and `is_us_survey_foot_tokens` in rust/core/src/unit_labels.rs — those two
+ * answer a metre scale for the georeferencing READER, this one answers the
+ * canonical name the STEP writer emits, but the accepted spellings are the
+ * same set and must stay the same set.
+ */
+function isUsSurveyFootTokens(tokens) {
+    const feet = tokens.filter((token) => FOOT_TOKENS.has(token));
+    if (feet.length !== 1)
+        return false;
+    const rest = tokens.filter((token) => !FOOT_TOKENS.has(token));
+    if (rest.length === 1)
+        return rest[0] === 'US' || rest[0] === 'USSURVEY';
+    return rest.length === 2 && rest.includes('US') && rest.includes('SURVEY');
+}
+/**
+ * Exact-match table from a folded label to the canonical unit name the rest of
+ * this module compares against. DERIVED rather than hand-written: the two base
+ * spellings crossed with {@link SI_PREFIXES} — the same list {@link siPrefixOf}
+ * reads, so the two cannot drift — plus the foot spellings this exporter can
+ * write as an `IfcConversionBasedUnit`.
+ *
+ * A `Map` rather than an object literal so a label like `CONSTRUCTOR` cannot
+ * resolve through `Object.prototype`.
+ */
+const MAP_UNIT_CANONICAL_NAME = (() => {
+    const table = new Map();
+    for (const spelling of ['METRE', 'METER']) {
+        table.set(spelling, 'METRE');
+        for (const prefix of SI_PREFIXES)
+            table.set(`${prefix}${spelling}`, `${prefix}METRE`);
+    }
+    for (const foot of ['FOOT', 'FEET'])
+        table.set(foot, 'FOOT');
+    // The US survey foot is a different ratio from the international foot
+    // (1200/3937 vs 0.3048) and is spelled several ways in the wild. These are
+    // the accepted glued spellings, matched exactly rather than sniffed for; the
+    // separated ones go through {@link isUsSurveyFootTokens}.
+    for (const alias of ['USSURVEYFOOT', 'USSURVEYFEET', 'USSURVEYFT', 'USFOOT', 'USFEET', 'USFT', 'FTUS']) {
+        table.set(alias, 'US SURVEY FOOT');
+    }
+    return table;
+})();
+/**
+ * Canonicalize a map-unit label to the spelling the rest of this module
+ * compares against: American `METER` to `METRE`, the foot spellings to `FOOT`,
+ * the US survey foot to `US SURVEY FOOT`, and an SI prefix kept rather than
+ * swallowed. Anything not recognised is returned normalised-but-unchanged, for
+ * the caller to REFUSE rather than guess at.
+ *
+ * The label is NORMALISED and then matched EXACTLY — never substring-matched.
+ *
+ * What the normalisation accepts:
+ * - any case and any separators: `metres`, `Meters`, `MILLI-METRE`;
+ * - `METRE` and `METER`, each carrying any `IfcSIPrefix` member;
+ * - `FOOT` and `FEET`;
+ * - one English plural suffix, stripped once and re-matched exactly;
+ * - the US survey foot, glued or separated in any word order.
+ *
+ * What it REFUSES, by leaving the label alone so `resolveMapUnitReference`
+ * returns `null` and `MapUnit` stays `$` with a warning:
+ * - a label that merely CONTAINS a unit. `MILLIMETRE`, `CENTIMETRE` and
+ *   `KILOMETRE` all contain `METRE`, and an `includes('METRE')` test wrote all
+ *   three into the file as a plain `.METRE.` — a silent 1000x error in the CRS
+ *   scale (#3274). The foot half of that same test was `includes('FOOT')`, and
+ *   it was satisfied by `FOOTCANDLE` (an illuminance), `FOOT-POUND` (an
+ *   energy), `FOOTPRINT`, and by `SQUARE FOOT` and `CUBIC FEET` — an area and
+ *   a volume written as a LENGTH unit, which is a wrong DIMENSION rather than
+ *   a wrong magnitude, and no scale factor can be right for it;
+ * - a survey foot with no nationality: `SURVEY FOOT`, `CLARKE'S FOOT`,
+ *   `INDIAN FOOT`, `SEARS FOOT`, `BRITISH FOOT (1936)` are five different
+ *   ratios, and `includes('FOOT')` gave every one of them the international
+ *   0.3048;
+ * - `INCH`, `YARD`, `MILE` and anything else this exporter cannot express.
+ *
+ * Normalising a recognisable spelling onto a table entry is NOT that
+ * approximation: the answer is still one exact table hit, so `MILLIMETERS`
+ * resolves to `MILLIMETRE` and not to `METRE`.
+ *
+ * Sibling of `inferMapUnitScaleFromLabel` in
+ * packages/parser/src/map-unit-label.ts and `infer_map_unit_scale` in
+ * rust/core/src/unit_labels.rs, which apply these same rules on the reading
+ * side. This exporter's accepted set is the smaller one — it writes only what
+ * it can express as an `IfcNamedUnit` — but no spelling may be accepted here
+ * that those refuse, or refused here that those accept as a length.
+ */
+export function normalizeMapUnitName(unitName) {
+    const normalized = unitName.trim().toUpperCase().replace(/\s+/g, ' ');
+    const tokens = tokenizeUnitLabel(normalized);
+    if (tokens.length === 0)
+        return normalized;
+    if (isUsSurveyFootTokens(tokens))
+        return 'US SURVEY FOOT';
+    const key = tokens.join('');
+    const exact = MAP_UNIT_CANONICAL_NAME.get(key);
+    if (exact !== undefined)
+        return exact;
+    // One English plural suffix, removed once and re-matched exactly. `ES`
+    // covers spellings whose singular is not reachable by dropping a single `S`.
+    for (const suffix of ['S', 'ES']) {
+        if (!key.endsWith(suffix))
+            continue;
+        const singular = MAP_UNIT_CANONICAL_NAME.get(key.slice(0, -suffix.length));
+        if (singular !== undefined)
+            return singular;
+    }
+    return normalized;
+}
+/**
+ * `effective` filters the candidates the same way the georef reads above do:
+ * returning a tombstoned unit id hands the caller a `#id` for a line the
+ * export never writes. Returning null instead makes `resolveMapUnitReference`
+ * synthesise a fresh unit, which is the outcome a deleted unit deserves.
+ */
+export function findLengthUnitReference(preferredUnitName, effective, ctx) {
+    if (!ctx.entityExtractor)
+        return null;
+    // An empty label is not a unit name, and it is reachable: the caller guards
+    // `crs.mapUnit !== undefined`, not `!== ''`, and `normalizeMapUnitName('')`
+    // is `''`. Both comparisons below fold a non-string Name attribute to `''`
+    // too, so without this an empty MapUnit binds to whichever unit happens to
+    // have a malformed name rather than to nothing.
+    if (preferredUnitName === '')
+        return null;
+    // Only source records carry the bytes `extractEntity` reads, so an
+    // overlay-created project is skipped rather than shadowing the file's own.
+    const projectId = (effective.byType.get('IFCPROJECT') ?? []).find((id) => ctx.dataStore.entityIndex.byId.has(id));
+    const projectRef = projectId !== undefined ? ctx.dataStore.entityIndex.byId.get(projectId) : undefined;
+    const project = projectRef ? ctx.entityExtractor.extractEntity(projectRef) : null;
+    const unitAssignmentId = project?.attributes?.[8];
+    if (typeof unitAssignmentId !== 'number' || effective.isDeleted(unitAssignmentId))
+        return null;
+    const unitAssignmentRef = ctx.dataStore.entityIndex.byId.get(unitAssignmentId);
+    const unitAssignment = unitAssignmentRef ? ctx.entityExtractor.extractEntity(unitAssignmentRef) : null;
+    const units = unitAssignment?.attributes?.[0];
+    if (!Array.isArray(units))
+        return null;
+    for (const unitId of units) {
+        if (typeof unitId !== 'number' || effective.isDeleted(unitId))
+            continue;
+        const unitRef = ctx.dataStore.entityIndex.byId.get(unitId);
+        const unit = unitRef ? ctx.entityExtractor.extractEntity(unitRef) : null;
+        if (!unit)
+            continue;
+        const typeName = unit.type.toUpperCase();
+        const attrs = unit.attributes ?? [];
+        const unitType = typeof attrs[1] === 'string' ? attrs[1].replace(/\./g, '').toUpperCase() : '';
+        if (unitType !== 'LENGTHUNIT')
+            continue;
+        if (typeName === 'IFCSIUNIT') {
+            const prefix = typeof attrs[2] === 'string' ? attrs[2].replace(/\./g, '').toUpperCase() : '';
+            const name = typeof attrs[3] === 'string' ? attrs[3].replace(/\./g, '').toUpperCase() : '';
+            // The prefix is part of the unit, so it is part of the comparison. The
+            // old test asked only whether the preferred name was `METRE` and the
+            // file's unit was a metre of any prefix, which both missed a reusable
+            // `.MILLI.` unit and would have matched one for a plain-metre request
+            // had `combined` been read (#3274).
+            const combined = prefix ? `${prefix}${name}` : name;
+            if (normalizeMapUnitName(combined) === preferredUnitName) {
+                return unitId;
+            }
+        }
+        if (typeName === 'IFCCONVERSIONBASEDUNIT') {
+            const name = typeof attrs[2] === 'string' ? normalizeMapUnitName(attrs[2]) : '';
+            if (name === preferredUnitName) {
+                return unitId;
+            }
+        }
+    }
+    return null;
+}
+//# sourceMappingURL=step-map-unit.js.map

package/dist/step-map-unit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-map-unit.js","sourceRoot":"","sources":["../src/step-map-unit.ts"],"names":[],"mappings":"AAAA;;+DAE+D;AA+B/D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,QAAgB;IACxD,OAAO,2BAA2B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,sKAAsK,CAAC;AACnO,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,wBAAwB,CAAC,QAAkB,EAAE,QAAgB;IAC3E,MAAM,OAAO,GAAG,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACpD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,OAAO,CAAC,IAAI,CAAC,kBAAkB,OAAO,EAAE,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,QAAgB,EAAE,cAAwB,EAAE,SAA+B,EAAE,GAAkB;IACrI,MAAM,UAAU,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,uBAAuB,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;IACrE,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4EAA4E;IAC5E,sEAAsE;IACtE,4EAA4E;IAC5E,+DAA+D;IAC/D,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACvC,MAAM,WAAW,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,MAAM,GAAG,CAAC;QAC1D,cAAc,CAAC,IAAI,CAAC,IAAI,MAAM,6BAA6B,WAAW,YAAY,CAAC,CAAC;QACpF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,gBAAgB,EAAE,CAAC;QAC7D,MAAM,KAAK,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,UAAU,KAAK,gBAAgB,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QACtE,MAAM,IAAI,GAAG,UAAU,KAAK,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC;QACzE,cAAc,CAAC,IAAI,CAAC,IAAI,KAAK,0CAA0C,CAAC,CAAC;QACzE,cAAc,CAAC,IAAI,CAAC,IAAI,QAAQ,uCAAuC,CAAC,CAAC;QACzE,cAAc,CAAC,IAAI,CAAC,IAAI,SAAS,wCAAwC,UAAU,CAAC,MAAM,CAAC,MAAM,QAAQ,IAAI,CAAC,CAAC;QAC/G,cAAc,CAAC,IAAI,CAAC,IAAI,UAAU,4BAA4B,KAAK,kBAAkB,IAAI,MAAM,SAAS,IAAI,CAAC,CAAC;QAC9G,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,4EAA4E;IAC5E,4EAA4E;IAC5E,2EAA2E;IAC3E,6EAA6E;IAC7E,uEAAuE;IACvE,uEAAuE;IACvE,OAAO,IAAI,CAAC;AACd,CAAC;AAED;iDACiD;AACjD,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO;IAC3C,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAC7E,CAAC;AAEX;;;;;;;;;GASG;AACH,SAAS,UAAU,CAAC,UAAkB;IACpC,IAAI,UAAU,KAAK,OAAO;QAAE,OAAO,IAAI,CAAC;IACxC,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,UAAU,KAAK,GAAG,MAAM,OAAO;YAAE,OAAO,MAAM,CAAC;IACrD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,mEAAmE;AACnE,SAAS,iBAAiB,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,wEAAwE;AACxE,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAS,oBAAoB,CAAC,MAAgB;IAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC;IACzE,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,uBAAuB,GAAwB,CAAC,GAAG,EAAE;IACzD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,KAAK,MAAM,QAAQ,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC;QAC1C,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC7B,KAAK,MAAM,MAAM,IAAI,WAAW;YAAE,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,QAAQ,EAAE,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC;IACxF,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;QAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7D,sEAAsE;IACtE,2EAA2E;IAC3E,6EAA6E;IAC7E,0DAA0D;IAC1D,KAAK,MAAM,KAAK,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QACvG,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC,EAAE,CAAC;AAEL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAAgB;IACnD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACtE,MAAM,MAAM,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,UAAU,CAAC;IAC3C,IAAI,oBAAoB,CAAC,MAAM,CAAC;QAAE,OAAO,gBAAgB,CAAC;IAE1D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,uBAAuB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAEtC,uEAAuE;IACvE,6EAA6E;IAC7E,KAAK,MAAM,MAAM,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,SAAS;QACpC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3E,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO,QAAQ,CAAC;IAC9C,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,iBAAyB,EAAE,SAA+B,EAAE,GAAwB;IAC1H,IAAI,CAAC,GAAG,CAAC,eAAe;QAAE,OAAO,IAAI,CAAC;IACtC,4EAA4E;IAC5E,4EAA4E;IAC5E,2EAA2E;IAC3E,2EAA2E;IAC3E,gDAAgD;IAChD,IAAI,iBAAiB,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAE1C,mEAAmE;IACnE,2EAA2E;IAC3E,MAAM,SAAS,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IAClH,MAAM,UAAU,GAAG,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvG,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAClF,MAAM,gBAAgB,GAAG,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,IAAI,OAAO,gBAAgB,KAAK,QAAQ,IAAI,SAAS,CAAC,SAAS,CAAC,gBAAgB,CAAC;QAAE,OAAO,IAAI,CAAC;IAE/F,MAAM,iBAAiB,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC/E,MAAM,cAAc,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvG,MAAM,KAAK,GAAG,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEvC,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;QAC3B,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,SAAS,CAAC,SAAS,CAAC,MAAM,CAAC;YAAE,SAAS;QACxE,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,IAAI,CAAC,IAAI;YAAE,SAAS;QAEpB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/F,IAAI,QAAQ,KAAK,YAAY;YAAE,SAAS;QAExC,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7F,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3F,uEAAuE;YACvE,qEAAqE;YACrE,sEAAsE;YACtE,sEAAsE;YACtE,oCAAoC;YACpC,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACpD,IAAI,oBAAoB,CAAC,QAAQ,CAAC,KAAK,iBAAiB,EAAE,CAAC;gBACzD,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QAED,IAAI,QAAQ,KAAK,wBAAwB,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAChF,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBAC/B,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/step-omission-predicates.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Which ids a STEP export may still NAME, once it has decided which ids it is
+ * writing.
+ *
+ * Split out of `step-exporter.ts` for #2475, verbatim apart from the two
+ * changes noted below. It runs immediately after `collectModifications` and
+ * before the output passes, and that position is not incidental: everything
+ * here reads what the collection phase produced -- `pass.modifiedEntities`,
+ * `pass.newGeorefLines`, `pass.allowedEntityIds`, `pass.overlayActive` -- and
+ * everything the output passes do with omitted references reads what this
+ * returns. Calling it earlier gives answers computed from an unpopulated pass.
+ *
+ * Why not in `step-collection.ts`: that module produces the values these
+ * predicates consume and never reads them back, so putting them there would
+ * relocate a dependency rather than remove one. That argument was always about
+ * `step-collection.ts` specifically, not about these predicates being welded
+ * to `export()`.
+ *
+ * TWO CHANGES FROM THE ORIGINAL, both forced by it becoming a function:
+ *
+ * 1. The deltaOnly empty short-circuit used to `return` out of `export()`.
+ *    A free function cannot, so it returns a tagged `'short-circuit'` result
+ *    the caller returns instead. That rewrite is safe by measurement, not by
+ *    argument: disabling the branch entirely leaves the suite green and the
+ *    emitted bytes and stats identical, because for a model with no edits the
+ *    ordinary path arrives at the same place. See
+ *    `delta-empty-shortcircuit.test.ts`, which pins the contract and says
+ *    outright that it does not pin the branch.
+ * 2. `this.mutationView` arrives as a parameter.
+ */
+import type { MutablePropertyView } from '@ifc-lite/mutations';
+import type { ExportPass, StepExportOptions, StepExportResult } from './step-export-types.js';
+/**
+ * Either the export is already over, or here are the two things the output
+ * passes need from it.
+ *
+ * A tagged union rather than an optional field, so a caller cannot read
+ * `isOmittedFromOutput` off a short-circuited result and get `undefined`
+ * without the compiler saying so.
+ */
+export type OmissionEvaluation = {
+    readonly kind: 'short-circuit';
+    readonly result: StepExportResult;
+} | {
+    readonly kind: 'continue';
+    readonly isOmittedFromOutput: (id: number) => boolean;
+    /** A boolean, not a predicate: the precondition both filter sites gate on. */
+    readonly mayNameOmittedRefs: boolean;
+};
+export declare function evaluateOmissionPredicates(pass: ExportPass, options: StepExportOptions, applyMutations: boolean, excludeGeometry: boolean, mutationView: MutablePropertyView | null): OmissionEvaluation;
+//# sourceMappingURL=step-omission-predicates.d.ts.map

package/dist/step-omission-predicates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-omission-predicates.d.ts","sourceRoot":"","sources":["../src/step-omission-predicates.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE9F;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAE,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE,GACrE;IACE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,mBAAmB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IACtD,8EAA8E;IAC9E,QAAQ,CAAC,kBAAkB,EAAE,OAAO,CAAC;CACtC,CAAC;AAEN,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,UAAU,EAChB,OAAO,EAAE,iBAAiB,EAC1B,cAAc,EAAE,OAAO,EACvB,eAAe,EAAE,OAAO,EACxB,YAAY,EAAE,mBAAmB,GAAG,IAAI,GACvC,kBAAkB,CA+QpB"}