@willcgage/module-schematic 0.35.0 → 0.36.0

package/dist/index.d.cts

@@ -435,6 +435,68 @@ declare function sectionSpans(doc: {
     fromPos: number;
     toPos: number;
 }[];
+/** A position expressed against the board it sits on, rather than as inches
+ * from endplate A (#109). */
+interface SectionRelativePos {
+    sectionId: string;
+    /** Inches from that section's own west end. */
+    offsetInches: number;
+}
+/**
+ * Section spans that ALWAYS cover the whole module. The owner's insight is
+ * what makes #109 tractable: every module has at least one section, even if
+ * that one section IS the whole module. So a module with no authored sections
+ * gets a single implicit span 0→length, every position falls inside exactly
+ * one span, and absolute ↔ relative becomes a total, lossless mapping with no
+ * un-convertible module and no orphan positions.
+ *
+ * The last span is also stretched to the module length when the sections come
+ * up short, so a position past the end still lands somewhere real.
+ */
+declare function sectionSpansOrWhole(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined, lengthInches: number): {
+    id: string;
+    name?: string;
+    fromPos: number;
+    toPos: number;
+}[];
+/** The id a module with no authored sections uses for its single implicit one. */
+declare const WHOLE_MODULE_SECTION_ID = "module";
+/**
+ * Absolute inches → the board it sits on plus an offset along it (#109).
+ * Total: given spans from `sectionSpansOrWhole`, every position resolves.
+ *
+ * A position exactly ON a joint is assigned to the section that STARTS there,
+ * at offset 0 — a joint is the west end of the next board, and that keeps the
+ * mapping single-valued. The module's own east end is the exception: nothing
+ * starts there, so it belongs to the last board.
+ */
+declare function toSectionRelative(pos: number, spans: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[]): SectionRelativePos | null;
+/** …and back. Null when the section is gone — which is the caller's cue that
+ * the thing it positioned has lost its board (#96 phase 3). */
+declare function fromSectionRelative(rel: SectionRelativePos, spans: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[]): number | null;
+/** Re-derive an absolute position after the sections have moved: read it
+ * against the OLD spans, write it against the NEW ones. This is the whole
+ * point of #109 — reorder or resize a board and everything on it comes along
+ * instead of silently pointing at a different board. */
+declare function remapPos(pos: number, before: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[], after: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[]): number | null;
 /** The joints implied by the sections — the interior boundaries, in inches from
  * endplate A. Replaces the authored `sectionBreaks` for a sectioned module. */
 declare function sectionBreaksFromSections(doc: {
@@ -1000,4 +1062,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, 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 OutlineFace, 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 SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionedCenterline, sectionedEndPose, sliceCenterline, stateToDoc, trackPath };
+export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, 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 OutlineFace, 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 TrackConfig, type TrackRole, type TurnoutKind, WHOLE_MODULE_SECTION_ID, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, fromSectionRelative, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, remapPos, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, stateToDoc, toSectionRelative, trackPath };

package/dist/index.d.ts

@@ -435,6 +435,68 @@ declare function sectionSpans(doc: {
     fromPos: number;
     toPos: number;
 }[];
+/** A position expressed against the board it sits on, rather than as inches
+ * from endplate A (#109). */
+interface SectionRelativePos {
+    sectionId: string;
+    /** Inches from that section's own west end. */
+    offsetInches: number;
+}
+/**
+ * Section spans that ALWAYS cover the whole module. The owner's insight is
+ * what makes #109 tractable: every module has at least one section, even if
+ * that one section IS the whole module. So a module with no authored sections
+ * gets a single implicit span 0→length, every position falls inside exactly
+ * one span, and absolute ↔ relative becomes a total, lossless mapping with no
+ * un-convertible module and no orphan positions.
+ *
+ * The last span is also stretched to the module length when the sections come
+ * up short, so a position past the end still lands somewhere real.
+ */
+declare function sectionSpansOrWhole(doc: {
+    sections?: SchematicSection[] | null;
+} | null | undefined, lengthInches: number): {
+    id: string;
+    name?: string;
+    fromPos: number;
+    toPos: number;
+}[];
+/** The id a module with no authored sections uses for its single implicit one. */
+declare const WHOLE_MODULE_SECTION_ID = "module";
+/**
+ * Absolute inches → the board it sits on plus an offset along it (#109).
+ * Total: given spans from `sectionSpansOrWhole`, every position resolves.
+ *
+ * A position exactly ON a joint is assigned to the section that STARTS there,
+ * at offset 0 — a joint is the west end of the next board, and that keeps the
+ * mapping single-valued. The module's own east end is the exception: nothing
+ * starts there, so it belongs to the last board.
+ */
+declare function toSectionRelative(pos: number, spans: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[]): SectionRelativePos | null;
+/** …and back. Null when the section is gone — which is the caller's cue that
+ * the thing it positioned has lost its board (#96 phase 3). */
+declare function fromSectionRelative(rel: SectionRelativePos, spans: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[]): number | null;
+/** Re-derive an absolute position after the sections have moved: read it
+ * against the OLD spans, write it against the NEW ones. This is the whole
+ * point of #109 — reorder or resize a board and everything on it comes along
+ * instead of silently pointing at a different board. */
+declare function remapPos(pos: number, before: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[], after: {
+    id: string;
+    fromPos: number;
+    toPos: number;
+}[]): number | null;
 /** The joints implied by the sections — the interior boundaries, in inches from
  * endplate A. Replaces the authored `sectionBreaks` for a sectioned module. */
 declare function sectionBreaksFromSections(doc: {
@@ -1000,4 +1062,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, 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 OutlineFace, 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 SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionedCenterline, sectionedEndPose, sliceCenterline, stateToDoc, trackPath };
+export { type BenchworkPoint, type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawIndustry, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorIndustry, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type EndplateWidthIssue, FREEMO_ENDPLATE_TRACK_FASCIA_CLEARANCE_INCHES, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, FREEMO_TRACK_SPACING_INCHES, type GeometryType, 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 OutlineFace, 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 TrackConfig, type TrackRole, type TurnoutKind, WHOLE_MODULE_SECTION_ID, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, fromSectionRelative, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, remapPos, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, stateToDoc, toSectionRelative, trackPath };

package/dist/index.js

@@ -205,6 +205,35 @@ function sectionSpans(doc) {
   }
   return out;
 }
+function sectionSpansOrWhole(doc, lengthInches) {
+  const L = lengthInches > 0 ? lengthInches : 0;
+  const spans = sectionSpans(doc);
+  if (!spans.length) return [{ id: WHOLE_MODULE_SECTION_ID, fromPos: 0, toPos: L }];
+  const out = spans.map((sp) => ({ ...sp }));
+  const last = out[out.length - 1];
+  if (L > last.toPos) last.toPos = L;
+  return out;
+}
+var WHOLE_MODULE_SECTION_ID = "module";
+function toSectionRelative(pos, spans) {
+  if (!spans.length) return null;
+  const p = Math.max(spans[0].fromPos, Math.min(spans[spans.length - 1].toPos, pos));
+  for (const sp of spans) {
+    if (p >= sp.fromPos && p < sp.toPos)
+      return { sectionId: sp.id, offsetInches: round3(p - sp.fromPos) };
+  }
+  const last = spans[spans.length - 1];
+  return { sectionId: last.id, offsetInches: round3(last.toPos - last.fromPos) };
+}
+function fromSectionRelative(rel, spans) {
+  const sp = spans.find((x) => x.id === rel.sectionId);
+  if (!sp) return null;
+  return round3(sp.fromPos + Math.max(0, Math.min(sp.toPos - sp.fromPos, rel.offsetInches)));
+}
+function remapPos(pos, before, after) {
+  const rel = toSectionRelative(pos, before);
+  return rel ? fromSectionRelative(rel, after) : null;
+}
 function sectionBreaksFromSections(doc) {
   const spans = sectionSpans(doc);
   return spans.slice(0, -1).map((sp) => sp.toPos);
@@ -481,6 +510,7 @@ function checkEndplateWidth(input) {
   return issues;
 }
 var round2 = (n) => Math.round(n * 100) / 100;
+var round3 = (n) => Math.round(n * 1e3) / 1e3;
 function endplateWidthFor(widths, id) {
   const w = widths?.[id];
   return typeof w === "number" && w > 0 ? w : FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES;
@@ -1383,6 +1413,6 @@ function poseOverridesFromDoc(doc) {
   return out;
 }
 
-export { 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, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionedCenterline, sectionedEndPose, sliceCenterline, stateToDoc, trackPath };
+export { 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, WHOLE_MODULE_SECTION_ID, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, checkEndplateWidth, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateTrackOffsetFor, endplateTrackOffsetInches, endplateWidthInches, fromSectionRelative, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, moduleLengthFromSections, moduleSections, nextId, poseNeedsManual, poseOverridesFromDoc, remapPos, sampleBenchworkOutline, samplePath, scaleFeetToInches, sectionAdjacency, sectionBand, sectionBreaksFromSections, sectionComponents, sectionFootprints, sectionNeighbours, sectionSpans, sectionSpansOrWhole, sectionedCenterline, sectionedEndPose, sliceCenterline, stateToDoc, toSectionRelative, trackPath };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map