@ifc-lite/bcf 2.0.0 → 3.0.0

package/README.md

@@ -54,7 +54,12 @@ const url = URL.createObjectURL(blob);
 ## Add a viewpoint with selection
 
 ```typescript
-import { createViewpoint, addViewpointToTopic } from '@ifc-lite/bcf';
+import { createBCFTopic, createViewpoint, addViewpointToTopic } from '@ifc-lite/bcf';
+
+const topic = createBCFTopic({
+  title: 'Missing fire rating on east-facade walls',
+  author: 'reviewer@example.com',
+});
 
 const viewpoint = createViewpoint({
   camera: {
@@ -62,6 +67,12 @@ const viewpoint = createViewpoint({
     target: { x: 0, y: 0, z: 0 },
     up: { x: 0, y: 0, z: 1 },
     fov: Math.PI / 3, // field of view in radians (60 degrees)
+    // Required for BCF 3.0 (viewport width / height, must be > 0). v3_0's
+    // visinfo.xsd makes `<AspectRatio>` mandatory on every camera and this
+    // package will not invent one, so `writeBCF` throws for the whole archive
+    // on the first camera that lacks it. Omit it only when writing 2.1, which
+    // has no such element.
+    aspectRatio: 16 / 9,
   },
   // Highlight specific entities by their IFC GlobalId
   selectedGuids: ['1abc2def3GhI4jKlM5nOpQ', '2bcd3efg4HiJ5kLmN6oPqR'],

package/dist/ids-camera.d.ts

@@ -0,0 +1,115 @@
+/**
+ * The camera half of the IDS to BCF reporter.
+ *
+ * Split out of `ids-reporter.ts` because BCF 3.0's camera rules are a policy
+ * of their own: `v3_0/visinfo.xsd` declares `OrthogonalCamera` and
+ * `PerspectiveCamera` as an `xs:choice` with the default `minOccurs`/
+ * `maxOccurs` of 1 (exactly one camera per viewpoint, required), and makes
+ * `<AspectRatio>` a required child of both. The reporter builds its own
+ * viewpoints rather than going through `createViewpoint`, so nothing else in
+ * this package enforced either rule for it -- both violations surfaced only
+ * from `writeBCF`, whole archives at a time, with no way back to the export
+ * option that caused them (#3849).
+ */
+import type { BCFPerspectiveCamera, BCFProject } from './types.js';
+/** Bounds for an entity, used for camera computation (viewer Y-up coords) */
+export interface EntityBoundsInput {
+    min: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    max: {
+        x: number;
+        y: number;
+        z: number;
+    };
+}
+/**
+ * Aspect ratio a computed camera gets when the caller names none.
+ *
+ * There is no viewport behind an IDS report -- the camera is derived from
+ * entity bounds, headlessly, and may never have been on screen. 16/9 is the
+ * convention for "no viewport existed": it is what the BCF sample files and
+ * the common desktop viewports use, and a viewer restoring the viewpoint
+ * re-frames to its own aspect anyway. This is the one place in the package
+ * that invents an aspect ratio, and it does so because a computed camera has
+ * no captured value to preserve; `writer-camera.ts` still refuses to invent
+ * one for a camera the CALLER supplied.
+ */
+export declare const DEFAULT_ASPECT_RATIO: number;
+/**
+ * Refuse an `aspectRatio` export option that no camera could carry.
+ *
+ * `visinfo.xsd` types `AspectRatio` as `PositiveDouble` -- `xs:double` with
+ * `minExclusive value="0"` -- so `0`, a negative number, `NaN` and `Infinity`
+ * are all invalid, and `writer-camera.ts` already rejects them. It can only
+ * name the viewpoint GUID it was writing, though: a value this package
+ * generated, for whichever topic came first, traceable to nothing the caller
+ * typed. Checking the option where the caller set it is the difference
+ * between "fix this argument" and "bisect your report".
+ *
+ * Checked for BOTH versions even though 2.1 emits no `AspectRatio`: the value
+ * is still wrong, it still lands on every camera in the project, and
+ * `readBCF` + re-export is how a 2.1 project becomes a 3.0 one.
+ */
+export declare function requireAspectRatioOption(aspectRatio: number): number;
+/**
+ * Slack left around the framed box, as a multiple of the fitted distance.
+ *
+ * The fit below puts the worst corner exactly on the frustum edge, which
+ * reads as a crop in any viewer that letterboxes or draws a border.
+ *
+ * Exported so the tests can take the padding back out and assert the fit
+ * underneath it is TIGHT. `cornersOutsideFrustum` is monotone in distance, so
+ * without that the whole corner-fit suite would pass on a camera parked
+ * arbitrarily far away.
+ */
+export declare const FRAMING_PADDING = 1.5;
+/**
+ * Compute a BCF perspective camera from entity bounds.
+ *
+ * Bounds are in viewer coordinates (Y-up).
+ * BCF uses Z-up, so we convert:
+ *   BCF.x = Viewer.x
+ *   BCF.y = -Viewer.z
+ *   BCF.z = Viewer.y
+ *
+ * Camera is placed at a southeast-isometric angle from the entity center,
+ * at a distance that frames the entity's bounding box with padding.
+ *
+ * @param aspectRatio - viewport ratio (width / height) written to
+ *   `AspectRatio` under BCF 3.0. 2.1 has no such element and the writer emits
+ *   none there, so one value serves both versions.
+ */
+export declare function computeCameraFromBounds(bounds: EntityBoundsInput, aspectRatio?: number): BCFPerspectiveCamera;
+/**
+ * The union of the boxes for EVERY key given, or `undefined` if any key has
+ * none.
+ *
+ * All-or-nothing for the reason {@link unionBounds} documents: the
+ * per-specification viewpoint frames a whole group of entities, and a union
+ * over the subset that happened to have bounds is a camera that leaves the
+ * rest off screen while looking entirely plausible. `undefined` leaves the
+ * viewpoint camera-less, which {@link requireCamerasForVersion} turns into a
+ * 3.0 refusal naming the topic and the missing option (#3849).
+ */
+export declare function unionBoundsForEveryKey(keys: readonly string[], entityBounds: Map<string, EntityBoundsInput> | undefined): EntityBoundsInput | undefined;
+/**
+ * Refuse a 3.0 project whose viewpoints have no camera, naming the topic.
+ *
+ * The reporter can only give a viewpoint a camera when the caller supplied
+ * bounds for the entities in it. Without them there is nothing to compute
+ * from, and inventing a framing would assert a view of the model nobody has
+ * -- the same policy `writer-camera.ts` applies to a missing `AspectRatio`.
+ * So we refuse; the only question is WHERE.
+ *
+ * Here, rather than in `writeBCF`, because the caller's mistake is an export
+ * OPTION (`version: '3.0'` with no `entityBounds`), and `writeBCF` can only
+ * report the viewpoint GUID of whichever topic it reached first -- a GUID this
+ * function generated moments earlier, which appears in nothing the caller
+ * wrote. Naming the topic, and the option that fixes it, is the difference
+ * between an error the caller can act on and one they have to bisect.
+ */
+export declare function requireCamerasForVersion(project: BCFProject): void;
+//# sourceMappingURL=ids-camera.d.ts.map

package/dist/ids-camera.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids-camera.d.ts","sourceRoot":"","sources":["../src/ids-camera.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEnE,6EAA6E;AAC7E,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,QAAS,CAAC;AAa3C;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,CAUpE;AAqBD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,MAAM,CAAC;AAgEnC;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,iBAAiB,EACzB,WAAW,GAAE,MAA6B,GACzC,oBAAoB,CAsCtB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,GACvD,iBAAiB,GAAG,SAAS,CAQ/B;AAqCD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,UAAU,GAAG,IAAI,CAelE"}

package/dist/ids-camera.js

@@ -0,0 +1,266 @@
+/* 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/. */
+/**
+ * Aspect ratio a computed camera gets when the caller names none.
+ *
+ * There is no viewport behind an IDS report -- the camera is derived from
+ * entity bounds, headlessly, and may never have been on screen. 16/9 is the
+ * convention for "no viewport existed": it is what the BCF sample files and
+ * the common desktop viewports use, and a viewer restoring the viewpoint
+ * re-frames to its own aspect anyway. This is the one place in the package
+ * that invents an aspect ratio, and it does so because a computed camera has
+ * no captured value to preserve; `writer-camera.ts` still refuses to invent
+ * one for a camera the CALLER supplied.
+ */
+export const DEFAULT_ASPECT_RATIO = 16 / 9;
+/**
+ * Vertical field of view of every computed camera, in degrees.
+ *
+ * Inside BCF 3.0's `(0, 180)` exclusive facet and BCF 2.1's `[45, 60]` one, so
+ * one value is writable under both.
+ */
+const FIELD_OF_VIEW_DEGREES = 60;
+/** How {@link DEFAULT_ASPECT_RATIO} reads in an error message. */
+const DEFAULT_ASPECT_RATIO_TEXT = '16/9';
+/**
+ * Refuse an `aspectRatio` export option that no camera could carry.
+ *
+ * `visinfo.xsd` types `AspectRatio` as `PositiveDouble` -- `xs:double` with
+ * `minExclusive value="0"` -- so `0`, a negative number, `NaN` and `Infinity`
+ * are all invalid, and `writer-camera.ts` already rejects them. It can only
+ * name the viewpoint GUID it was writing, though: a value this package
+ * generated, for whichever topic came first, traceable to nothing the caller
+ * typed. Checking the option where the caller set it is the difference
+ * between "fix this argument" and "bisect your report".
+ *
+ * Checked for BOTH versions even though 2.1 emits no `AspectRatio`: the value
+ * is still wrong, it still lands on every camera in the project, and
+ * `readBCF` + re-export is how a 2.1 project becomes a 3.0 one.
+ */
+export function requireAspectRatioOption(aspectRatio) {
+    if (!Number.isFinite(aspectRatio) || aspectRatio <= 0) {
+        throw new Error(`createBCFFromIDSReport's aspectRatio option must be a finite number ` +
+            `greater than 0 (got ${aspectRatio}). BCF 3.0's visinfo.xsd types ` +
+            `AspectRatio as PositiveDouble, so this value could not be written; ` +
+            `omit the option to use the ${DEFAULT_ASPECT_RATIO_TEXT} default.`);
+    }
+    return aspectRatio;
+}
+function dot(a, b) {
+    return a[0] * b[0] + a[1] * b[1] + a[2] * b[2];
+}
+function cross(a, b) {
+    return [
+        a[1] * b[2] - a[2] * b[1],
+        a[2] * b[0] - a[0] * b[2],
+        a[0] * b[1] - a[1] * b[0],
+    ];
+}
+function normalize(v) {
+    const len = Math.sqrt(dot(v, v));
+    return [v[0] / len, v[1] / len, v[2] / len];
+}
+/**
+ * Slack left around the framed box, as a multiple of the fitted distance.
+ *
+ * The fit below puts the worst corner exactly on the frustum edge, which
+ * reads as a crop in any viewer that letterboxes or draws a border.
+ *
+ * Exported so the tests can take the padding back out and assert the fit
+ * underneath it is TIGHT. `cornersOutsideFrustum` is monotone in distance, so
+ * without that the whole corner-fit suite would pass on a camera parked
+ * arbitrarily far away.
+ */
+export const FRAMING_PADDING = 1.5;
+/**
+ * Floor on the FITTED distance for a box with no size, in model units.
+ *
+ * A point fits at every distance including zero, which would put the camera
+ * inside the entity it is meant to be looking at. Floored before
+ * {@link FRAMING_PADDING} applies, so the standoff such a box actually gets is
+ * this times the padding.
+ */
+const MIN_FRAMED_DISTANCE = 0.1;
+/**
+ * The southeast-isometric camera basis, in viewer coordinates (Y-up).
+ *
+ * Fixed for every computed camera, so it is derived once here rather than per
+ * call. The camera sits at `center + CAMERA_OFFSET * distance` and looks back
+ * along `CAMERA_FORWARD`; `CAMERA_RIGHT` and `CAMERA_UP` are perpendicular to
+ * that, which is why the standoff cancels out of a corner's sideways offsets
+ * in the fit below and appears only in its depth.
+ */
+const CAMERA_OFFSET = normalize([0.6, 0.5, 0.6]);
+const CAMERA_FORWARD = [-CAMERA_OFFSET[0], -CAMERA_OFFSET[1], -CAMERA_OFFSET[2]];
+const CAMERA_RIGHT = normalize(cross(CAMERA_FORWARD, [0, 1, 0]));
+const CAMERA_UP = cross(CAMERA_RIGHT, CAMERA_FORWARD);
+/**
+ * The smallest standoff along {@link CAMERA_OFFSET} that puts every corner of
+ * `bounds` inside both half-angles, before padding.
+ *
+ * The distance used to come from the largest SIDE of the box, which is not
+ * what the projection sees: down this isometric axis a box projects wider than
+ * any of its sides, so a unit cube's worst corner sat at a vertical slope of
+ * 0.837 against the tan(30 deg) = 0.577 limit at 16/9, and overran
+ * horizontally at 9/16 (#3882). Only the corners answer the question, so all
+ * eight are walked.
+ *
+ * A corner's sideways offsets `h` and `v` do not depend on the standoff, and
+ * its depth is `dot(corner, CAMERA_FORWARD) + distance`. It is inside when
+ * `h <= tanH * depth` and `v <= tanV * depth`; solving each for `distance` and
+ * taking the largest satisfies all sixteen constraints at once, because
+ * growing the distance only ever relaxes them.
+ */
+function fitCornersInFrustum(bounds, center, tanH, tanV) {
+    let distance = 0;
+    for (const x of [bounds.min.x, bounds.max.x]) {
+        for (const y of [bounds.min.y, bounds.max.y]) {
+            for (const z of [bounds.min.z, bounds.max.z]) {
+                const corner = [x - center[0], y - center[1], z - center[2]];
+                const depthAtCenter = dot(corner, CAMERA_FORWARD);
+                const h = Math.abs(dot(corner, CAMERA_RIGHT)) / tanH;
+                const v = Math.abs(dot(corner, CAMERA_UP)) / tanV;
+                distance = Math.max(distance, h - depthAtCenter, v - depthAtCenter);
+            }
+        }
+    }
+    return distance;
+}
+/**
+ * Compute a BCF perspective camera from entity bounds.
+ *
+ * Bounds are in viewer coordinates (Y-up).
+ * BCF uses Z-up, so we convert:
+ *   BCF.x = Viewer.x
+ *   BCF.y = -Viewer.z
+ *   BCF.z = Viewer.y
+ *
+ * Camera is placed at a southeast-isometric angle from the entity center,
+ * at a distance that frames the entity's bounding box with padding.
+ *
+ * @param aspectRatio - viewport ratio (width / height) written to
+ *   `AspectRatio` under BCF 3.0. 2.1 has no such element and the writer emits
+ *   none there, so one value serves both versions.
+ */
+export function computeCameraFromBounds(bounds, aspectRatio = DEFAULT_ASPECT_RATIO) {
+    // Center in viewer coords (Y-up)
+    const center = [
+        (bounds.min.x + bounds.max.x) / 2,
+        (bounds.min.y + bounds.max.y) / 2,
+        (bounds.min.z + bounds.max.z) / 2,
+    ];
+    // `FieldOfView` is the VERTICAL angle in BCF, and the horizontal one follows
+    // from the aspect ratio: tan(hHalf) = aspectRatio * tan(vHalf). Both bound
+    // every corner below, so neither a portrait nor a landscape viewport crops
+    // the box.
+    const tanV = Math.tan((FIELD_OF_VIEW_DEGREES * Math.PI) / 360);
+    const tanH = aspectRatio * tanV;
+    const distance = Math.max(fitCornersInFrustum(bounds, center, tanH, tanV), MIN_FRAMED_DISTANCE) *
+        FRAMING_PADDING;
+    // Southeast-isometric position in viewer coords (Y-up).
+    const camX = center[0] + CAMERA_OFFSET[0] * distance;
+    const camY = center[1] + CAMERA_OFFSET[1] * distance;
+    const camZ = center[2] + CAMERA_OFFSET[2] * distance;
+    // Convert to BCF coords (Z-up)
+    // Viewer (x, y, z) → BCF (x, -z, y). The camera sits on the +CAMERA_OFFSET
+    // ray from the center, so it looks back along CAMERA_FORWARD exactly.
+    return {
+        cameraViewPoint: { x: camX, y: -camZ, z: camY },
+        cameraDirection: {
+            x: CAMERA_FORWARD[0],
+            y: -CAMERA_FORWARD[2],
+            z: CAMERA_FORWARD[1],
+        },
+        cameraUpVector: { x: 0, y: 0, z: 1 }, // BCF Z-up
+        fieldOfView: FIELD_OF_VIEW_DEGREES,
+        aspectRatio,
+    };
+}
+/**
+ * The union of the boxes for EVERY key given, or `undefined` if any key has
+ * none.
+ *
+ * All-or-nothing for the reason {@link unionBounds} documents: the
+ * per-specification viewpoint frames a whole group of entities, and a union
+ * over the subset that happened to have bounds is a camera that leaves the
+ * rest off screen while looking entirely plausible. `undefined` leaves the
+ * viewpoint camera-less, which {@link requireCamerasForVersion} turns into a
+ * 3.0 refusal naming the topic and the missing option (#3849).
+ */
+export function unionBoundsForEveryKey(keys, entityBounds) {
+    const boxes = [];
+    for (const key of keys) {
+        const box = entityBounds?.get(key);
+        if (!box)
+            return undefined;
+        boxes.push(box);
+    }
+    return unionBounds(boxes);
+}
+/**
+ * The box containing every bound given, or `undefined` when none were.
+ *
+ * CONTRACT: the caller must pass a box for EVERY entity the viewpoint frames.
+ * A union over a subset is not a smaller mistake than no camera at all -- it
+ * is a camera that looks convincing and leaves the uncovered entities off
+ * screen, with nothing in the file saying so. `buildTopicsPerSpecification`
+ * therefore passes `undefined` unless it has bounds for all of them, which
+ * makes {@link requireCamerasForVersion} refuse the 3.0 export by name rather
+ * than write a partial frame.
+ *
+ * Per-specification grouping puts many entities in ONE viewpoint, so no single
+ * entity's box is the right frame for it. Framing the union is what lets that
+ * grouping produce a 3.0-writable camera at all -- otherwise `entityBounds`
+ * would be an option that fixes per-entity and per-requirement exports while
+ * leaving the third grouping permanently unwritable, and the refusal below
+ * would be naming a remedy that does not work for it.
+ */
+function unionBounds(boxes) {
+    if (boxes.length === 0)
+        return undefined;
+    const min = { ...boxes[0].min };
+    const max = { ...boxes[0].max };
+    for (const box of boxes.slice(1)) {
+        min.x = Math.min(min.x, box.min.x);
+        min.y = Math.min(min.y, box.min.y);
+        min.z = Math.min(min.z, box.min.z);
+        max.x = Math.max(max.x, box.max.x);
+        max.y = Math.max(max.y, box.max.y);
+        max.z = Math.max(max.z, box.max.z);
+    }
+    return { min, max };
+}
+/**
+ * Refuse a 3.0 project whose viewpoints have no camera, naming the topic.
+ *
+ * The reporter can only give a viewpoint a camera when the caller supplied
+ * bounds for the entities in it. Without them there is nothing to compute
+ * from, and inventing a framing would assert a view of the model nobody has
+ * -- the same policy `writer-camera.ts` applies to a missing `AspectRatio`.
+ * So we refuse; the only question is WHERE.
+ *
+ * Here, rather than in `writeBCF`, because the caller's mistake is an export
+ * OPTION (`version: '3.0'` with no `entityBounds`), and `writeBCF` can only
+ * report the viewpoint GUID of whichever topic it reached first -- a GUID this
+ * function generated moments earlier, which appears in nothing the caller
+ * wrote. Naming the topic, and the option that fixes it, is the difference
+ * between an error the caller can act on and one they have to bisect.
+ */
+export function requireCamerasForVersion(project) {
+    if (project.version !== '3.0')
+        return;
+    for (const topic of project.topics.values()) {
+        for (const viewpoint of topic.viewpoints) {
+            if (viewpoint.perspectiveCamera || viewpoint.orthogonalCamera)
+                continue;
+            throw new Error(`BCF 3.0 requires exactly one camera per viewpoint, and topic ` +
+                `"${topic.title}" (${topic.guid}) has a viewpoint with none. ` +
+                `createBCFFromIDSReport computes a camera only from entityBounds, ` +
+                `so pass entityBounds covering every reported entity ` +
+                `(keyed "modelId:expressId"), or export version "2.1" and set an ` +
+                `explicit camera on each viewpoint before writing 3.0.`);
+        }
+    }
+}
+//# sourceMappingURL=ids-camera.js.map

package/dist/ids-camera.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids-camera.js","sourceRoot":"","sources":["../src/ids-camera.ts"],"names":[],"mappings":"AAAA;;+DAE+D;AAwB/D;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,CAAC,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,kEAAkE;AAClE,MAAM,yBAAyB,GAAG,MAAM,CAAC;AAEzC;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,wBAAwB,CAAC,WAAmB;IAC1D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CACb,sEAAsE;YACpE,uBAAuB,WAAW,iCAAiC;YACnE,qEAAqE;YACrE,8BAA8B,yBAAyB,WAAW,CACrE,CAAC;IACJ,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAID,SAAS,GAAG,CAAC,CAAO,EAAE,CAAO;IAC3B,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,KAAK,CAAC,CAAO,EAAE,CAAO;IAC7B,OAAO;QACL,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,CAAO;IACxB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACjC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAC;AAEnC;;;;;;;GAOG;AACH,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEhC;;;;;;;;GAQG;AACH,MAAM,aAAa,GAAG,SAAS,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AACjD,MAAM,cAAc,GAAS,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AACvF,MAAM,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACjE,MAAM,SAAS,GAAG,KAAK,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;GAgBG;AACH,SAAS,mBAAmB,CAC1B,MAAyB,EACzB,MAAY,EACZ,IAAY,EACZ,IAAY;IAEZ,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAS,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnE,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;gBAClD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,GAAG,IAAI,CAAC;gBACrD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC;gBAClD,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC;YACtE,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAAyB,EACzB,cAAsB,oBAAoB;IAE1C,iCAAiC;IACjC,MAAM,MAAM,GAAS;QACnB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACjC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACjC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;KAClC,CAAC;IAEF,6EAA6E;IAC7E,2EAA2E;IAC3E,2EAA2E;IAC3E,WAAW;IACX,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,qBAAqB,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC;IAC/D,MAAM,IAAI,GAAG,WAAW,GAAG,IAAI,CAAC;IAEhC,MAAM,QAAQ,GACZ,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,mBAAmB,CAAC;QAC9E,eAAe,CAAC;IAElB,wDAAwD;IACxD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;IACrD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;IACrD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC;IAErD,+BAA+B;IAC/B,2EAA2E;IAC3E,sEAAsE;IACtE,OAAO;QACL,eAAe,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE;QAC/C,eAAe,EAAE;YACf,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;YACpB,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;YACrB,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC;SACrB;QACD,cAAc,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,WAAW;QACjD,WAAW,EAAE,qBAAqB;QAClC,WAAW;KACZ,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,sBAAsB,CACpC,IAAuB,EACvB,YAAwD;IAExD,MAAM,KAAK,GAAwB,EAAE,CAAC;IACtC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,YAAY,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,CAAC,GAAG;YAAE,OAAO,SAAS,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAS,WAAW,CAClB,KAAmC;IAEnC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACzC,MAAM,GAAG,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IAChC,MAAM,GAAG,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IAChC,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACnC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACnC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACnC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACnC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACnC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAmB;IAC1D,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK;QAAE,OAAO;IACtC,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;QAC5C,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YACzC,IAAI,SAAS,CAAC,iBAAiB,IAAI,SAAS,CAAC,gBAAgB;gBAAE,SAAS;YACxE,MAAM,IAAI,KAAK,CACb,+DAA+D;gBAC7D,IAAI,KAAK,CAAC,KAAK,MAAM,KAAK,CAAC,IAAI,+BAA+B;gBAC9D,mEAAmE;gBACnE,sDAAsD;gBACtD,kEAAkE;gBAClE,uDAAuD,CAC1D,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/ids-reporter.d.ts

@@ -17,6 +17,8 @@
  * - Configurable grouping strategies
  */
 import type { BCFProject } from './types.js';
+import type { EntityBoundsInput } from './ids-camera.js';
+export type { EntityBoundsInput } from './ids-camera.js';
 /** Input for the BCF reporter — structurally matches IDSValidationReport */
 export interface IDSReportInput {
     /** IDS document title */
@@ -63,19 +65,6 @@ export interface IDSEntityResultInput {
     passed: boolean;
     requirementResults: IDSRequirementResultInput[];
 }
-/** Bounds for an entity — used for camera computation in viewpoints (Y-up viewer coords) */
-export interface EntityBoundsInput {
-    min: {
-        x: number;
-        y: number;
-        z: number;
-    };
-    max: {
-        x: number;
-        y: number;
-        z: number;
-    };
-}
 /** Requirement result — structurally matches IDSRequirementResult */
 export interface IDSRequirementResultInput {
     status: 'pass' | 'fail' | 'not_applicable';
@@ -116,6 +105,21 @@ export interface IDSBCFExportOptions {
      * When provided, viewpoints will include a perspective camera framing the entity.
      */
     entityBounds?: Map<string, EntityBoundsInput>;
+    /**
+     * Viewport aspect ratio (width / height) for computed cameras.
+     *
+     * BCF 3.0's `visinfo.xsd` requires `<AspectRatio>` on every camera, and an
+     * IDS export is headless -- the camera is derived from entity bounds, so
+     * there is no viewport to read one from. Defaults to 16/9, the convention
+     * when no viewport exists; pass the real viewport ratio when the export runs
+     * beside one. 2.1 has no such element, so this changes nothing there.
+     *
+     * The viewer's own IDS export (`apps/viewer/src/hooks/useIDS.ts`, where it
+     * builds `exportOptions` for `createBCFFromIDSReport`) sets none today; it
+     * is the call site to wire `Camera.getAspect()` into if that dialog ever
+     * offers 3.0, which it currently does not.
+     */
+    aspectRatio?: number;
     /**
      * Entity snapshot map for attaching screenshots to viewpoints.
      * Key: "modelId:expressId", Value: data URL (PNG).

package/dist/ids-reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ids-reporter.d.ts","sourceRoot":"","sources":["../src/ids-reporter.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,UAAU,EAA4D,MAAM,YAAY,CAAC;AAsDvG,4EAA4E;AAC5E,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,oBAAoB,EAAE,kBAAkB,EAAE,CAAC;CAC5C;AAED,yEAAyE;AACzE,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE;QACb,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC;IAC3C,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,oBAAoB,EAAE,CAAC;IACtC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE;QAClB,MAAM,EAAE,OAAO,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;QACnC,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,yBAAyB,EAAE,CAAC;CACjD;AAED,4FAA4F;AAC5F,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,GAAG,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C;AAED,qEAAqE;AACrE,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD,qCAAqC;AACrC,MAAM,WAAW,mBAAmB;IAClC,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IACxB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;IACvE,+DAA+D;IAC/D,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8CAA8C;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC9C;;;;OAIG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC;AAsBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,mBAAwB,GAChC,UAAU,CAqDZ"}
+{"version":3,"file":"ids-reporter.d.ts","sourceRoot":"","sources":["../src/ids-reporter.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAsC,MAAM,YAAY,CAAC;AASjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,YAAY,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAqDzD,4EAA4E;AAC5E,MAAM,WAAW,cAAc;IAC7B,yBAAyB;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,oBAAoB,EAAE,kBAAkB,EAAE,CAAC;CAC5C;AAED,yEAAyE;AACzE,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE;QACb,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC;IAC3C,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,oBAAoB,EAAE,CAAC;IACtC;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE;QAClB,MAAM,EAAE,OAAO,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;QACnC,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,2DAA2D;AAC3D,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,yBAAyB,EAAE,CAAC;CACjD;AAED,qEAAqE;AACrE,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAMD,qCAAqC;AACrC,MAAM,WAAW,mBAAmB;IAClC,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IACxB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;IACvE,+DAA+D;IAC/D,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8CAA8C;IAC9C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+EAA+E;IAC/E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC9C;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC;AAsBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,cAAc,EACtB,OAAO,GAAE,mBAAwB,GAChC,UAAU,CAiEZ"}