@willcgage/module-schematic 0.13.3 → 0.14.0

package/dist/index.d.cts

@@ -43,7 +43,23 @@ interface SchematicEndplate {
         y: number;
         heading: number;
     };
+    /** Free-moN endplate FACE width across the track, inches — the physical size
+     * of the standard interface at this end. Free-moN spec: 12″ minimum, 24″
+     * recommended. Absent = the recommended default (modules may differ end to
+     * end, e.g. a transition). */
+    widthInches?: number | null;
 }
+/** Free-moN endplate face width, inches — the connection interface size. */
+declare const FREEMO_ENDPLATE_WIDTH_MIN_INCHES = 12;
+declare const FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES = 24;
+/**
+ * The authored face width for an endplate, or the recommended default when a
+ * module hasn't authored one. The single source of truth both apps read so a
+ * module's endplate size is drawn the same in the Repository and the layout.
+ */
+declare function endplateWidthInches(ep: {
+    widthInches?: number | null;
+} | null | undefined): number;
 interface SchematicTrack {
     id: string;
     role: TrackRole;
@@ -244,6 +260,9 @@ interface EditorState {
         y: number;
         heading: number;
     }>;
+    /** Authored endplate face widths by endplate id, inches (Free-moN 12″ min,
+     * 24″ recommended). Absent id = the recommended default. */
+    endplateWidths: Record<string, number>;
     controlPoints: EditorControlPoint[];
 }
 /** Build the empty editor state for a module of the given length. */
@@ -504,4 +523,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type GeometryType, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_SCALE_RATIO, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleFeatures, nextId, poseNeedsManual, poseOverridesFromDoc, scaleFeetToInches, stateToDoc };
+export { type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, type GeometryType, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_SCALE_RATIO, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleFeatures, nextId, poseNeedsManual, poseOverridesFromDoc, scaleFeetToInches, stateToDoc };

package/dist/index.d.ts

@@ -43,7 +43,23 @@ interface SchematicEndplate {
         y: number;
         heading: number;
     };
+    /** Free-moN endplate FACE width across the track, inches — the physical size
+     * of the standard interface at this end. Free-moN spec: 12″ minimum, 24″
+     * recommended. Absent = the recommended default (modules may differ end to
+     * end, e.g. a transition). */
+    widthInches?: number | null;
 }
+/** Free-moN endplate face width, inches — the connection interface size. */
+declare const FREEMO_ENDPLATE_WIDTH_MIN_INCHES = 12;
+declare const FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES = 24;
+/**
+ * The authored face width for an endplate, or the recommended default when a
+ * module hasn't authored one. The single source of truth both apps read so a
+ * module's endplate size is drawn the same in the Repository and the layout.
+ */
+declare function endplateWidthInches(ep: {
+    widthInches?: number | null;
+} | null | undefined): number;
 interface SchematicTrack {
     id: string;
     role: TrackRole;
@@ -244,6 +260,9 @@ interface EditorState {
         y: number;
         heading: number;
     }>;
+    /** Authored endplate face widths by endplate id, inches (Free-moN 12″ min,
+     * 24″ recommended). Absent id = the recommended default. */
+    endplateWidths: Record<string, number>;
     controlPoints: EditorControlPoint[];
 }
 /** Build the empty editor state for a module of the given length. */
@@ -504,4 +523,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, type GeometryType, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_SCALE_RATIO, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleFeatures, nextId, poseNeedsManual, poseOverridesFromDoc, scaleFeetToInches, stateToDoc };
+export { type BranchConnector, type DrawCrossing, type DrawCrossover, type DrawSignal, type DrawTrack, type DrawTurnout, type EditorBranch, type EditorControlPoint, type EditorCpSignal, type EditorCrossing, type EditorState, type EditorTrack, type EditorTurnout, type EndplateBConfig, type EndplatePose, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, type GeometryType, MAIN2_TRACK_ID, MAIN_TRACK_ID, type ModuleFeatures, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_SCALE_RATIO, type SchematicBlock, type SchematicControlPoint, type SchematicCrossing, type SchematicEndplate, type SchematicEndplateTrack, type SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleFeatures, nextId, poseNeedsManual, poseOverridesFromDoc, scaleFeetToInches, stateToDoc };

package/dist/index.js

@@ -1,4 +1,10 @@
 // src/index.ts
+var FREEMO_ENDPLATE_WIDTH_MIN_INCHES = 12;
+var FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES = 24;
+function endplateWidthInches(ep) {
+  const w = ep?.widthInches;
+  return typeof w === "number" && w > 0 ? w : FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES;
+}
 function isLoopDoc(doc) {
   return doc.loop === true || doc.endplates.length === 1;
 }
@@ -30,6 +36,7 @@ function emptyEditorState(lengthInches) {
     crossings: [],
     branches: [],
     poseOverrides: {},
+    endplateWidths: {},
     controlPoints: []
   };
 }
@@ -91,6 +98,12 @@ function withPoses(endplates, overrides) {
     (e) => overrides[e.id] ? { ...e, pose: overrides[e.id] } : e
   );
 }
+function withWidths(endplates, widths) {
+  return endplates.map((e) => {
+    const w = widths[e.id];
+    return typeof w === "number" && w > 0 ? { ...e, widthInches: w } : e;
+  });
+}
 function stateToDoc(state, recordNumber) {
   return {
     version: 1,
@@ -98,42 +111,45 @@ function stateToDoc(state, recordNumber) {
     lengthInches: state.lengthInches,
     ...state.loop ? { loop: true } : {},
     ...state.loop && state.loopReturn === "main2" ? { loopReturn: "main2" } : {},
-    endplates: withPoses(
-      [
-        ...state.loop ? (
-          // Balloon loop: A is the entry. A standard endplate B on the balloon
-          // makes it an INTERCHANGE (second route connects at the loop, e.g.
-          // Seaford); configB "none" makes it a pure turnback.
-          [
-            { id: "A", label: "Entry", tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: state.configA }] },
-            ...state.configB !== "none" ? [{ id: "B", label: "Interchange", tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: state.configB }] }] : []
-          ]
-        ) : [
-          { id: "A", label: "West", tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: state.configA }] },
-          // Non-loop modules always have a real B ("none" never applies).
-          {
-            id: "B",
-            label: "East",
-            tracks: [
-              {
-                trackId: MAIN_TRACK_ID,
-                lane: 0,
-                config: state.configB === "none" ? "single" : state.configB
-              }
+    endplates: withWidths(
+      withPoses(
+        [
+          ...state.loop ? (
+            // Balloon loop: A is the entry. A standard endplate B on the balloon
+            // makes it an INTERCHANGE (second route connects at the loop, e.g.
+            // Seaford); configB "none" makes it a pure turnback.
+            [
+              { id: "A", label: "Entry", tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: state.configA }] },
+              ...state.configB !== "none" ? [{ id: "B", label: "Interchange", tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: state.configB }] }] : []
             ]
-          }
+          ) : [
+            { id: "A", label: "West", tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: state.configA }] },
+            // Non-loop modules always have a real B ("none" never applies).
+            {
+              id: "B",
+              label: "East",
+              tracks: [
+                {
+                  trackId: MAIN_TRACK_ID,
+                  lane: 0,
+                  config: state.configB === "none" ? "single" : state.configB
+                }
+              ]
+            }
+          ],
+          // Branch endplates C, D, … — junction connections at pos, off one side
+          // (#170). A set can carry several (e.g. a second railroad through).
+          ...state.branches.map((b, i) => ({
+            id: String.fromCharCode(67 + i),
+            // C, D, E…
+            label: b.label || `Branch ${i + 1}`,
+            tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: b.config }],
+            at: { pos: b.pos, side: b.side }
+          }))
         ],
-        // Branch endplates C, D, … — junction connections at pos, off one side
-        // (#170). A set can carry several (e.g. a second railroad through).
-        ...state.branches.map((b, i) => ({
-          id: String.fromCharCode(67 + i),
-          // C, D, E…
-          label: b.label || `Branch ${i + 1}`,
-          tracks: [{ trackId: MAIN_TRACK_ID, lane: 0, config: b.config }],
-          at: { pos: b.pos, side: b.side }
-        }))
-      ],
-      state.poseOverrides
+        state.poseOverrides
+      ),
+      state.endplateWidths
     ),
     tracks: [
       state.loop ? (
@@ -259,6 +275,11 @@ function docToState(doc, fallbackLength, moduleTracks = []) {
     (e) => e.id !== "A" && e.id !== "B" && e.at
   );
   const poseOverrides = poseOverridesFromDoc(d);
+  const endplateWidths = {};
+  for (const e of d.endplates ?? []) {
+    if (typeof e.widthInches === "number" && e.widthInches > 0)
+      endplateWidths[e.id] = e.widthInches;
+  }
   return {
     lengthInches: len,
     loop,
@@ -273,6 +294,7 @@ function docToState(doc, fallbackLength, moduleTracks = []) {
       config: ep.tracks?.[0]?.config === "double" ? "double" : "single"
     })),
     poseOverrides,
+    endplateWidths,
     crossings: (d.crossings ?? []).map((x) => ({
       id: x.id,
       name: x.name ?? "",
@@ -730,6 +752,6 @@ function poseOverridesFromDoc(doc) {
   return out;
 }
 
-export { MAIN2_TRACK_ID, MAIN_TRACK_ID, N_SCALE_RATIO, asModuleSchematic, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleFeatures, nextId, poseNeedsManual, poseOverridesFromDoc, scaleFeetToInches, stateToDoc };
+export { FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, MAIN2_TRACK_ID, MAIN_TRACK_ID, N_SCALE_RATIO, asModuleSchematic, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleFeatures, nextId, poseNeedsManual, poseOverridesFromDoc, scaleFeetToInches, stateToDoc };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map