@willcgage/module-schematic 0.75.0 → 0.77.0

package/dist/index.d.cts

@@ -366,6 +366,35 @@ interface SchematicSection {
     geometryDegrees?: number | null;
     /** Lateral jog, for offset sections. */
     geometryOffsetInches?: number | null;
+    /** This board's WEST end (the A side) — see {@link SectionEnd}. */
+    endA?: SectionEnd | null;
+    /** This board's EAST end (the B side). */
+    endB?: SectionEnd | null;
+}
+/**
+ * One end of a board (#130).
+ *
+ * Owner's question was *"how would I update my section joints to be endplates
+ * from within MR?"* — and until now nothing could say it: a section had a
+ * length, a shape and an outline, but nothing about its ends.
+ *
+ * ⚠️ **There is deliberately no "this is an endplate" flag.** An owner could
+ * tick it wrongly and the registry would then tell Free-Dispatcher that two
+ * boards will physically mate when they won't. The geometry decides — describe
+ * the end and {@link assessSectionEnd} works out whether it conforms.
+ *
+ * Absent means **not described**, which is an ordinary internal joint, not a
+ * failing endplate: the standard exempts internal boundaries from the
+ * end-interface rules (#96).
+ */
+interface SectionEnd {
+    /** What this end presents. `"none"` = a closed end (a bumper). */
+    config?: TrackConfig | "none" | null;
+    /** Face width, inches. Absent = the recommended default. */
+    widthInches?: number | null;
+    /** Main 1's signed distance from the face centre — the standard's own
+     * framing, same as an endplate's (see {@link endplateTrackOffsetInches}). */
+    trackOffsetInches?: number | null;
 }
 /** The authored benchwork outline, or null when a module hasn't drawn one
  * (renderers then fall back to a band derived from the endplate widths). A
@@ -843,6 +872,62 @@ declare function usableCapacity(input: {
     library?: TrackPart[];
     carLengthInches?: number;
 }): UsableCapacity;
+/** What a board's end is, once the geometry has been asked (#130). */
+interface SectionEndAssessment {
+    /** Has the owner described this end at all? Undescribed is an ordinary
+     * internal joint — exempt from the end-interface rules (#96) — not a failure. */
+    described: boolean;
+    /** Does it meet the standard's end-interface rules? Only a described end can. */
+    conforming: boolean;
+    /** Why it doesn't, when it doesn't. Empty for a conforming or undescribed end. */
+    issues: EndplateWidthIssue[];
+    /** The resolved values the assessment was made against. */
+    config: TrackConfig | "none";
+    widthInches: number;
+    trackOffsetInches: number;
+}
+/**
+ * Is this end of a board a standard endplate? (#130)
+ *
+ * ⭐ **Derived, never declared.** The issue is emphatic and the reason is good:
+ * a checkbox could be ticked wrongly, and the registry would then promise
+ * Free-Dispatcher a mating surface that doesn't exist. So the answer comes from
+ * the same rules {@link checkEndplateWidth} already applies to a module's own
+ * plates — §1.1's 12″ minimum, and §2.0's 4″ fascia clearance and 1.125″ pair.
+ *
+ * Two of the standard's conditions aren't checked because they can't be false
+ * here: track crosses the face **perpendicular** and a double end's two tracks
+ * sit **1.125″ apart** are both true by construction in this model. Inventing
+ * fields for them would be inventing ways to be wrong.
+ *
+ * An end with no config is **undescribed**, which is the ordinary case — most
+ * joints inside a module are just joints.
+ */
+declare function assessSectionEnd(end: SectionEnd | null | undefined, opts?: {
+    main2Below?: boolean;
+}): SectionEndAssessment;
+/** Two board ends meeting at a joint, and whether that joint is a standard
+ * interface (#130). */
+interface SectionJointAssessment {
+    west: SectionEndAssessment;
+    east: SectionEndAssessment;
+    /** Both ends conform AND present the same number of tracks — so these two
+     * boards could be separated and each used against any other module. */
+    standardInterface: boolean;
+    /** Plain-language reason it isn't one, or null when it is. */
+    reason: string | null;
+}
+/**
+ * Assess a joint — the two board ends that meet there (#130).
+ *
+ * ⚠️ Track COUNT is the only compatibility rule. Two conforming ends of
+ * differing face WIDTH still mate: the standard lets plates differ in width and
+ * be offset, so long as the track lines up. That's a deliberate non-check — see
+ * the note on endplate width authoring.
+ */
+declare function assessSectionJoint(west: SectionEnd | null | undefined, east: SectionEnd | null | undefined, opts?: {
+    main2Below?: boolean;
+}): SectionJointAssessment;
 /** How much of a car-spot span has no rail under it (#194). */
 interface SpanOverhang {
     /** Inches the span runs past the track's near end (0 = it starts on track). */
@@ -2047,6 +2132,10 @@ interface ModuleGeometryInput {
         y: number;
         heading: number;
     }>;
+    /** Authored endplate FACE widths by id ("A"/"B"), inches — the board's depth.
+     * Needed to place a branch endplate on the benchwork edge rather than on the
+     * centre line; absent ends use the recommended default. */
+    endplateWidths?: Record<string, number>;
     /** Half the spacing between the two tracks of a double endplate (Free-mo ≈ 1",
      * Free-moN ≈ 9/16"). */
     trackHalfSpacingInches?: number;
@@ -2125,4 +2214,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { ATLAS_CODE55_N, BUILT_IN_TRACK_PARTS, type BenchworkPoint, type BranchConnector, CLEARANCE_SPACING_INCHES, CODE55_RAIL_HEIGHT_INCHES, DEFAULT_FLEX_PART_ID, type DimensionSource, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, ENDPLATE_FASCIA_CLEAR_INCHES, ENDPLATE_LEAD_INCHES, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateTrackIssue, type EndplateWidthIssue, FLEX_TRACK_PARTS, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type FlexPiece, type FlexPieceEnd, type FrogCasting, type GeometryType, type ImportedPart, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OccupiedSpan, type OutlineFace, type PartAngle, type PartDimension, type PartEnd, type PartExtent, type PartSegment, RAIL_GAUGE_INCHES, type ReturnLoopGeometry, type ReturnLoopShape, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SectionAdjacency, type SectionFootprint, type SectionRelativePos, type SignalFacing, type SignalSide, type SpanOverhang, type StoredTrackPart, TIE_HALF_LENGTH_INCHES, TURNOUT_LEAD_INCHES_PER_FROG, type TrackConfig, type TrackPart, type TrackRole, type TurnoutClosure, type TurnoutKind, type UsableCapacity, WHOLE_MODULE_SECTION_ID, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, clearancePointPastFrogInches, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateCentreOffsetInches, endplateFaceSegments, endplateLead, endplateTrackOffsetInches, endplateWidthInches, flexPartFor, flexParts, flexPieces, flexUsage, frogCasting, frogNumberFromName, fromSectionRelative, geometryTurnDegrees, hasNoFarEndplate, importedPartToTrackPart, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, leadInchesForSize, maxFlexPieceInches, mergeImportedParts, mergeStoredParts, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, parseXtpLibrary, partExtent, partExtentForSize, partOutlineAtFrog, pastFrogInchesForSize, pathLengthInches, poseNeedsManual, poseOverridesFromDoc, remapPos, resizeFlexPiece, returnLoop, sampleBenchworkOutline, samplePartSegments, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, spanOverhang, stateToDoc, storedPartToTrackPart, toSectionRelative, trackMeetsEndplateIssues, trackPart, trackPath, turnoutClosure, turnoutFacing, turnoutOccupiedSpan, turnoutPartForSize, usableCapacity };
+export { ATLAS_CODE55_N, BUILT_IN_TRACK_PARTS, type BenchworkPoint, type BranchConnector, CLEARANCE_SPACING_INCHES, CODE55_RAIL_HEIGHT_INCHES, DEFAULT_FLEX_PART_ID, type DimensionSource, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, ENDPLATE_FASCIA_CLEAR_INCHES, ENDPLATE_LEAD_INCHES, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateTrackIssue, type EndplateWidthIssue, FLEX_TRACK_PARTS, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type FlexPiece, type FlexPieceEnd, type FrogCasting, type GeometryType, type ImportedPart, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OccupiedSpan, type OutlineFace, type PartAngle, type PartDimension, type PartEnd, type PartExtent, type PartSegment, RAIL_GAUGE_INCHES, type ReturnLoopGeometry, type ReturnLoopShape, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SectionAdjacency, type SectionEnd, type SectionEndAssessment, type SectionFootprint, type SectionJointAssessment, type SectionRelativePos, type SignalFacing, type SignalSide, type SpanOverhang, type StoredTrackPart, TIE_HALF_LENGTH_INCHES, TURNOUT_LEAD_INCHES_PER_FROG, type TrackConfig, type TrackPart, type TrackRole, type TurnoutClosure, type TurnoutKind, type UsableCapacity, WHOLE_MODULE_SECTION_ID, asModuleSchematic, assessSectionEnd, assessSectionJoint, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, clearancePointPastFrogInches, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateCentreOffsetInches, endplateFaceSegments, endplateLead, endplateTrackOffsetInches, endplateWidthInches, flexPartFor, flexParts, flexPieces, flexUsage, frogCasting, frogNumberFromName, fromSectionRelative, geometryTurnDegrees, hasNoFarEndplate, importedPartToTrackPart, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, leadInchesForSize, maxFlexPieceInches, mergeImportedParts, mergeStoredParts, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, parseXtpLibrary, partExtent, partExtentForSize, partOutlineAtFrog, pastFrogInchesForSize, pathLengthInches, poseNeedsManual, poseOverridesFromDoc, remapPos, resizeFlexPiece, returnLoop, sampleBenchworkOutline, samplePartSegments, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, spanOverhang, stateToDoc, storedPartToTrackPart, toSectionRelative, trackMeetsEndplateIssues, trackPart, trackPath, turnoutClosure, turnoutFacing, turnoutOccupiedSpan, turnoutPartForSize, usableCapacity };

package/dist/index.d.ts

@@ -366,6 +366,35 @@ interface SchematicSection {
     geometryDegrees?: number | null;
     /** Lateral jog, for offset sections. */
     geometryOffsetInches?: number | null;
+    /** This board's WEST end (the A side) — see {@link SectionEnd}. */
+    endA?: SectionEnd | null;
+    /** This board's EAST end (the B side). */
+    endB?: SectionEnd | null;
+}
+/**
+ * One end of a board (#130).
+ *
+ * Owner's question was *"how would I update my section joints to be endplates
+ * from within MR?"* — and until now nothing could say it: a section had a
+ * length, a shape and an outline, but nothing about its ends.
+ *
+ * ⚠️ **There is deliberately no "this is an endplate" flag.** An owner could
+ * tick it wrongly and the registry would then tell Free-Dispatcher that two
+ * boards will physically mate when they won't. The geometry decides — describe
+ * the end and {@link assessSectionEnd} works out whether it conforms.
+ *
+ * Absent means **not described**, which is an ordinary internal joint, not a
+ * failing endplate: the standard exempts internal boundaries from the
+ * end-interface rules (#96).
+ */
+interface SectionEnd {
+    /** What this end presents. `"none"` = a closed end (a bumper). */
+    config?: TrackConfig | "none" | null;
+    /** Face width, inches. Absent = the recommended default. */
+    widthInches?: number | null;
+    /** Main 1's signed distance from the face centre — the standard's own
+     * framing, same as an endplate's (see {@link endplateTrackOffsetInches}). */
+    trackOffsetInches?: number | null;
 }
 /** The authored benchwork outline, or null when a module hasn't drawn one
  * (renderers then fall back to a band derived from the endplate widths). A
@@ -843,6 +872,62 @@ declare function usableCapacity(input: {
     library?: TrackPart[];
     carLengthInches?: number;
 }): UsableCapacity;
+/** What a board's end is, once the geometry has been asked (#130). */
+interface SectionEndAssessment {
+    /** Has the owner described this end at all? Undescribed is an ordinary
+     * internal joint — exempt from the end-interface rules (#96) — not a failure. */
+    described: boolean;
+    /** Does it meet the standard's end-interface rules? Only a described end can. */
+    conforming: boolean;
+    /** Why it doesn't, when it doesn't. Empty for a conforming or undescribed end. */
+    issues: EndplateWidthIssue[];
+    /** The resolved values the assessment was made against. */
+    config: TrackConfig | "none";
+    widthInches: number;
+    trackOffsetInches: number;
+}
+/**
+ * Is this end of a board a standard endplate? (#130)
+ *
+ * ⭐ **Derived, never declared.** The issue is emphatic and the reason is good:
+ * a checkbox could be ticked wrongly, and the registry would then promise
+ * Free-Dispatcher a mating surface that doesn't exist. So the answer comes from
+ * the same rules {@link checkEndplateWidth} already applies to a module's own
+ * plates — §1.1's 12″ minimum, and §2.0's 4″ fascia clearance and 1.125″ pair.
+ *
+ * Two of the standard's conditions aren't checked because they can't be false
+ * here: track crosses the face **perpendicular** and a double end's two tracks
+ * sit **1.125″ apart** are both true by construction in this model. Inventing
+ * fields for them would be inventing ways to be wrong.
+ *
+ * An end with no config is **undescribed**, which is the ordinary case — most
+ * joints inside a module are just joints.
+ */
+declare function assessSectionEnd(end: SectionEnd | null | undefined, opts?: {
+    main2Below?: boolean;
+}): SectionEndAssessment;
+/** Two board ends meeting at a joint, and whether that joint is a standard
+ * interface (#130). */
+interface SectionJointAssessment {
+    west: SectionEndAssessment;
+    east: SectionEndAssessment;
+    /** Both ends conform AND present the same number of tracks — so these two
+     * boards could be separated and each used against any other module. */
+    standardInterface: boolean;
+    /** Plain-language reason it isn't one, or null when it is. */
+    reason: string | null;
+}
+/**
+ * Assess a joint — the two board ends that meet there (#130).
+ *
+ * ⚠️ Track COUNT is the only compatibility rule. Two conforming ends of
+ * differing face WIDTH still mate: the standard lets plates differ in width and
+ * be offset, so long as the track lines up. That's a deliberate non-check — see
+ * the note on endplate width authoring.
+ */
+declare function assessSectionJoint(west: SectionEnd | null | undefined, east: SectionEnd | null | undefined, opts?: {
+    main2Below?: boolean;
+}): SectionJointAssessment;
 /** How much of a car-spot span has no rail under it (#194). */
 interface SpanOverhang {
     /** Inches the span runs past the track's near end (0 = it starts on track). */
@@ -2047,6 +2132,10 @@ interface ModuleGeometryInput {
         y: number;
         heading: number;
     }>;
+    /** Authored endplate FACE widths by id ("A"/"B"), inches — the board's depth.
+     * Needed to place a branch endplate on the benchwork edge rather than on the
+     * centre line; absent ends use the recommended default. */
+    endplateWidths?: Record<string, number>;
     /** Half the spacing between the two tracks of a double endplate (Free-mo ≈ 1",
      * Free-moN ≈ 9/16"). */
     trackHalfSpacingInches?: number;
@@ -2125,4 +2214,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { ATLAS_CODE55_N, BUILT_IN_TRACK_PARTS, type BenchworkPoint, type BranchConnector, CLEARANCE_SPACING_INCHES, CODE55_RAIL_HEIGHT_INCHES, DEFAULT_FLEX_PART_ID, type DimensionSource, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, ENDPLATE_FASCIA_CLEAR_INCHES, ENDPLATE_LEAD_INCHES, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateTrackIssue, type EndplateWidthIssue, FLEX_TRACK_PARTS, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type FlexPiece, type FlexPieceEnd, type FrogCasting, type GeometryType, type ImportedPart, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OccupiedSpan, type OutlineFace, type PartAngle, type PartDimension, type PartEnd, type PartExtent, type PartSegment, RAIL_GAUGE_INCHES, type ReturnLoopGeometry, type ReturnLoopShape, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SectionAdjacency, type SectionFootprint, type SectionRelativePos, type SignalFacing, type SignalSide, type SpanOverhang, type StoredTrackPart, TIE_HALF_LENGTH_INCHES, TURNOUT_LEAD_INCHES_PER_FROG, type TrackConfig, type TrackPart, type TrackRole, type TurnoutClosure, type TurnoutKind, type UsableCapacity, WHOLE_MODULE_SECTION_ID, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, clearancePointPastFrogInches, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateCentreOffsetInches, endplateFaceSegments, endplateLead, endplateTrackOffsetInches, endplateWidthInches, flexPartFor, flexParts, flexPieces, flexUsage, frogCasting, frogNumberFromName, fromSectionRelative, geometryTurnDegrees, hasNoFarEndplate, importedPartToTrackPart, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, leadInchesForSize, maxFlexPieceInches, mergeImportedParts, mergeStoredParts, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, parseXtpLibrary, partExtent, partExtentForSize, partOutlineAtFrog, pastFrogInchesForSize, pathLengthInches, poseNeedsManual, poseOverridesFromDoc, remapPos, resizeFlexPiece, returnLoop, sampleBenchworkOutline, samplePartSegments, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, spanOverhang, stateToDoc, storedPartToTrackPart, toSectionRelative, trackMeetsEndplateIssues, trackPart, trackPath, turnoutClosure, turnoutFacing, turnoutOccupiedSpan, turnoutPartForSize, usableCapacity };
+export { ATLAS_CODE55_N, BUILT_IN_TRACK_PARTS, type BenchworkPoint, type BranchConnector, CLEARANCE_SPACING_INCHES, CODE55_RAIL_HEIGHT_INCHES, DEFAULT_FLEX_PART_ID, type DimensionSource, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, ENDPLATE_FASCIA_CLEAR_INCHES, ENDPLATE_LEAD_INCHES, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateTrackIssue, type EndplateWidthIssue, FLEX_TRACK_PARTS, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type FlexPiece, type FlexPieceEnd, type FrogCasting, type GeometryType, type ImportedPart, type IndustryLabelMode, type IndustrySpot, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, type OccupiedSpan, type OutlineFace, type PartAngle, type PartDimension, type PartEnd, type PartExtent, type PartSegment, RAIL_GAUGE_INCHES, type ReturnLoopGeometry, type ReturnLoopShape, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicIndustry, type SchematicSection, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SectionAdjacency, type SectionEnd, type SectionEndAssessment, type SectionFootprint, type SectionJointAssessment, type SectionRelativePos, type SignalFacing, type SignalSide, type SpanOverhang, type StoredTrackPart, TIE_HALF_LENGTH_INCHES, TURNOUT_LEAD_INCHES_PER_FROG, type TrackConfig, type TrackPart, type TrackRole, type TurnoutClosure, type TurnoutKind, type UsableCapacity, WHOLE_MODULE_SECTION_ID, asModuleSchematic, assessSectionEnd, assessSectionJoint, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, clearancePointPastFrogInches, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateCentreOffsetInches, endplateFaceSegments, endplateLead, endplateTrackOffsetInches, endplateWidthInches, flexPartFor, flexParts, flexPieces, flexUsage, frogCasting, frogNumberFromName, fromSectionRelative, geometryTurnDegrees, hasNoFarEndplate, importedPartToTrackPart, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, leadInchesForSize, maxFlexPieceInches, mergeImportedParts, mergeStoredParts, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, parseXtpLibrary, partExtent, partExtentForSize, partOutlineAtFrog, pastFrogInchesForSize, pathLengthInches, poseNeedsManual, poseOverridesFromDoc, remapPos, resizeFlexPiece, returnLoop, sampleBenchworkOutline, samplePartSegments, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, spanOverhang, stateToDoc, storedPartToTrackPart, toSectionRelative, trackMeetsEndplateIssues, trackPart, trackPath, turnoutClosure, turnoutFacing, turnoutOccupiedSpan, turnoutPartForSize, usableCapacity };

package/dist/index.js

@@ -29,10 +29,28 @@ function moduleSections(doc) {
       ...typeof len === "number" && Number.isFinite(len) && len > 0 ? { lengthInches: len } : {},
       ...sec.geometryType ? { geometryType: sec.geometryType } : {},
       ...typeof deg === "number" && Number.isFinite(deg) ? { geometryDegrees: deg } : {},
-      ...typeof off === "number" && Number.isFinite(off) ? { geometryOffsetInches: off } : {}
+      ...typeof off === "number" && Number.isFinite(off) ? { geometryOffsetInches: off } : {},
+      // The board's two ends (#130). Written only when actually described —
+      // an absent end is an ordinary internal joint, and an empty object
+      // would claim the owner had said something about it.
+      ...sectionEnd(sec.endA) ? { endA: sectionEnd(sec.endA) } : {},
+      ...sectionEnd(sec.endB) ? { endB: sectionEnd(sec.endB) } : {}
     };
   });
 }
+function sectionEnd(end) {
+  if (!end) return null;
+  const config = end.config === "single" || end.config === "double" || end.config === "none" ? end.config : null;
+  const w = end.widthInches;
+  const o = end.trackOffsetInches;
+  const out = {
+    ...config ? { config } : {},
+    ...typeof w === "number" && Number.isFinite(w) && w > 0 ? { widthInches: w } : {},
+    // Signed, and 0 is meaningful ("explicitly centred", #93) — keep any finite.
+    ...typeof o === "number" && Number.isFinite(o) ? { trackOffsetInches: o } : {}
+  };
+  return Object.keys(out).length ? out : null;
+}
 function sectionFootprints(doc, derive) {
   const spans = derive ? sectionSpans(doc) : [];
   const spanOf = new Map(spans.map((sp) => [sp.id, sp]));
@@ -625,6 +643,42 @@ function usableCapacity(input) {
     scaleFeet: Math.round(inchesToScaleFeet(usable))
   };
 }
+function assessSectionEnd(end, opts = {}) {
+  const config = end?.config ?? "none";
+  const widthInches = endplateWidthInches({ widthInches: end?.widthInches });
+  const trackOffsetInches = endplateTrackOffsetInches(
+    end?.trackOffsetInches,
+    config,
+    opts.main2Below
+  );
+  const described = config === "single" || config === "double";
+  if (!described) {
+    return { described: false, conforming: false, issues: [], config, widthInches, trackOffsetInches };
+  }
+  const issues = checkEndplateWidth({
+    widthInches: end?.widthInches,
+    config,
+    trackOffsetInches: end?.trackOffsetInches,
+    main2Below: opts.main2Below
+  });
+  return { described: true, conforming: issues.length === 0, issues, config, widthInches, trackOffsetInches };
+}
+function assessSectionJoint(west, east, opts = {}) {
+  const w = assessSectionEnd(west, opts);
+  const e = assessSectionEnd(east, opts);
+  let reason = null;
+  if (!w.described || !e.described) {
+    reason = "an internal joint \u2014 neither end has been described as an interface";
+    if (w.described !== e.described)
+      reason = `only the ${w.described ? "west" : "east"} side is described as an endplate`;
+  } else if (!w.conforming || !e.conforming) {
+    const bad = !w.conforming ? w : e;
+    reason = bad.issues[0]?.message ?? "an end doesn't meet the standard";
+  } else if (w.config !== e.config) {
+    reason = `${w.config} meets ${e.config} \u2014 the track counts differ`;
+  }
+  return { west: w, east: e, standardInterface: reason === null, reason };
+}
 function spanOverhang(input) {
   const lo = Math.min(input.fromPos, input.toPos);
   const hi = Math.max(input.fromPos, input.toPos);
@@ -2316,15 +2370,21 @@ function deriveEndplatePoses(geo) {
       })
     );
   }
+  const widthAt = (frac) => {
+    const wa = endplateWidthFor(geo.endplateWidths, "A");
+    const wb = endplateWidthFor(geo.endplateWidths, "B");
+    return (wa * (1 - frac) + wb * frac) / 2;
+  };
   for (const b of geo.branches ?? []) {
     const frac = L > 0 ? Math.min(1, Math.max(0, b.atPos / L)) : 0;
     const px = frac * L;
     const config = b.config === "double" ? "double" : "single";
+    const depth = widthAt(frac);
     poses.push(
       withOverride({
         id: b.id,
         x: px,
-        y: 0,
+        y: b.side === "down" ? -depth : depth,
         heading: b.side === "down" ? 270 : 90,
         trackConfig: config,
         trackOffsets: offsetsFor(config, half)
@@ -2423,6 +2483,6 @@ function poseOverridesFromDoc(doc) {
   return out;
 }
 
-export { ATLAS_CODE55_N, BUILT_IN_TRACK_PARTS, CLEARANCE_SPACING_INCHES, CODE55_RAIL_HEIGHT_INCHES, DEFAULT_FLEX_PART_ID, ENDPLATE_FASCIA_CLEAR_INCHES, ENDPLATE_LEAD_INCHES, FLEX_TRACK_PARTS, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, MAIN2_TRACK_ID, MAIN_TRACK_ID, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, RAIL_GAUGE_INCHES, TIE_HALF_LENGTH_INCHES, TURNOUT_LEAD_INCHES_PER_FROG, WHOLE_MODULE_SECTION_ID, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, clearancePointPastFrogInches, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateCentreOffsetInches, endplateFaceSegments, endplateLead, endplateTrackOffsetInches, endplateWidthInches, flexPartFor, flexParts, flexPieces, flexUsage, frogCasting, frogNumberFromName, fromSectionRelative, geometryTurnDegrees, hasNoFarEndplate, importedPartToTrackPart, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, leadInchesForSize, maxFlexPieceInches, mergeImportedParts, mergeStoredParts, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, parseXtpLibrary, partExtent, partExtentForSize, partOutlineAtFrog, pastFrogInchesForSize, pathLengthInches, poseNeedsManual, poseOverridesFromDoc, remapPos, resizeFlexPiece, returnLoop, sampleBenchworkOutline, samplePartSegments, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, spanOverhang, stateToDoc, storedPartToTrackPart, toSectionRelative, trackMeetsEndplateIssues, trackPart, trackPath, turnoutClosure, turnoutFacing, turnoutOccupiedSpan, turnoutPartForSize, usableCapacity };
+export { ATLAS_CODE55_N, BUILT_IN_TRACK_PARTS, CLEARANCE_SPACING_INCHES, CODE55_RAIL_HEIGHT_INCHES, DEFAULT_FLEX_PART_ID, ENDPLATE_FASCIA_CLEAR_INCHES, ENDPLATE_LEAD_INCHES, FLEX_TRACK_PARTS, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, MAIN2_TRACK_ID, MAIN_TRACK_ID, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, RAIL_GAUGE_INCHES, TIE_HALF_LENGTH_INCHES, TURNOUT_LEAD_INCHES_PER_FROG, WHOLE_MODULE_SECTION_ID, asModuleSchematic, assessSectionEnd, assessSectionJoint, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, clearancePointPastFrogInches, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateCentreOffsetInches, endplateFaceSegments, endplateLead, endplateTrackOffsetInches, endplateWidthInches, flexPartFor, flexParts, flexPieces, flexUsage, frogCasting, frogNumberFromName, fromSectionRelative, geometryTurnDegrees, hasNoFarEndplate, importedPartToTrackPart, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, leadInchesForSize, maxFlexPieceInches, mergeImportedParts, mergeStoredParts, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, parseXtpLibrary, partExtent, partExtentForSize, partOutlineAtFrog, pastFrogInchesForSize, pathLengthInches, poseNeedsManual, poseOverridesFromDoc, remapPos, resizeFlexPiece, returnLoop, sampleBenchworkOutline, samplePartSegments, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, spanOverhang, stateToDoc, storedPartToTrackPart, toSectionRelative, trackMeetsEndplateIssues, trackPart, trackPath, turnoutClosure, turnoutFacing, turnoutOccupiedSpan, turnoutPartForSize, usableCapacity };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map