@willcgage/module-schematic 0.17.0 → 0.18.0

package/dist/index.d.cts

@@ -132,6 +132,35 @@ interface SchematicControlPoint {
     crossings?: string[];
     signals?: SchematicSignal[];
 }
+/** What a rendered industry shows beside its name: a car count, a length in
+ * inches, or nothing (name only). Authored per industry. */
+type IndustryLabelMode = "none" | "cars" | "inches";
+/**
+ * An industry — a rail-served customer that spots cars, authored as a SPAN on a
+ * track (a spur/siding, or the main). Positional like everything else: it lives
+ * in the same module-local inch frame and is rendered into the shared 2-D view,
+ * offset to `side`. The span length gives its car capacity; the dispatcher and
+ * crews read where cars set out. Mirrors a `freemon_industries` row.
+ */
+interface SchematicIndustry {
+    id: string;
+    name: string;
+    /** Industry type value from the lookup (e.g. "team_track", "grain"). */
+    type?: string | null;
+    /** The track this industry spots cars on (a spur/siding id, or the main). */
+    track: string;
+    /** The car-spot span along that track, inches from endplate A. */
+    fromPos: number;
+    toPos: number;
+    /** Which side of the track the building + label sit on. */
+    side?: SignalSide;
+    /** Secondary readout at the label — a car count, a length, or none. */
+    labelMode?: IndustryLabelMode;
+    /** Car types this industry receives (car-type value strings). */
+    carTypes?: string[];
+    /** The `freemon_industries` row this is (single source of truth); null = new. */
+    moduleIndustryId?: number | null;
+}
 interface ModuleSchematicDoc {
     version: number;
     module?: string;
@@ -156,6 +185,8 @@ interface ModuleSchematicDoc {
     /** Grade crossings / diamonds (#170). */
     crossings?: SchematicCrossing[];
     controlPoints?: SchematicControlPoint[];
+    /** Rail-served industries — car-spot spans on a track (#industries). */
+    industries?: SchematicIndustry[];
     /** Benchwork FOOTPRINT outline — the module's physical board shape as a
      * polygon in module-local inches, in the same frame as the endplate poses
      * (endplate A's track point at the origin, the mainline along +x, perpendicular
@@ -243,6 +274,13 @@ declare const N_SCALE_RATIO = 160;
 declare function inchesToScaleFeet(inches: number, ratio?: number): number;
 /** Scale feet of prototype track → real inches on the module. */
 declare function scaleFeetToInches(feet: number, ratio?: number): number;
+/** Length a spotted car occupies on N-scale track, inches. A 40-ft car body is
+ * ~3.0″; ~3.3″ over the couplers — the real spacing a cut of cars takes. The
+ * single constant every repo reads so a track's car count matches everywhere. */
+declare const N_CAR_LENGTH_INCHES = 3.3;
+/** How many cars fit in a span, from its drawn length — the derived capacity a
+ * siding or an industry spot holds (never typed). */
+declare function carCapacity(fromPos: number, toPos: number, carLengthInches?: number): number;
 /** Parse a jsonb value into a schematic doc, or null if it isn't one. */
 declare function asModuleSchematic(x: unknown): ModuleSchematicDoc | null;
 interface EditorTrack {
@@ -294,6 +332,20 @@ interface EditorCrossing {
     trackA: string;
     trackB: string;
 }
+/** An industry as the authoring form binds it — a car-spot span on a track. */
+interface EditorIndustry {
+    id: string;
+    name: string;
+    type: string;
+    track: string;
+    fromPos: number;
+    toPos: number;
+    side: SignalSide;
+    labelMode: IndustryLabelMode;
+    carTypes: string[];
+    /** freemon_industries row (single source of truth), or null for a new one. */
+    moduleIndustryId: number | null;
+}
 /** A 3rd+ endplate — a branch/junction connection off the module (#170).
  * A module may have several (e.g. a set carrying a second railroad through:
  * MoPac enters at one branch endplate and leaves at another). */
@@ -339,6 +391,8 @@ interface EditorState {
      * Empty = no authored outline (fall back to the endplate-width band). */
     outline: BenchworkPoint[];
     controlPoints: EditorControlPoint[];
+    /** Rail-served industries — car-spot spans on a track (#industries). */
+    industries: EditorIndustry[];
 }
 /** Build the empty editor state for a module of the given length. */
 declare function emptyEditorState(lengthInches: number): EditorState;
@@ -469,6 +523,23 @@ interface BranchConnector {
     posFrac: number;
     side: "up" | "down";
 }
+/** An industry — draw a car-spot span beside its track's lane, on `side`, with
+ * a name label + an optional car/length readout (#industries). */
+interface DrawIndustry {
+    id: string;
+    name: string;
+    type: string | null;
+    /** Span as fractions of module length (sorted West→East). */
+    fromFrac: number;
+    toFrac: number;
+    /** Lane of the track it spots on, so it draws beside the right track. */
+    lane: number;
+    side: SignalSide;
+    labelMode: IndustryLabelMode;
+    /** Cars that spot here, derived from the drawn span length. */
+    cars: number;
+    carTypes: string[];
+}
 interface ModuleFeatures {
     /** Whether either endplate declares a double-track main. */
     doubleMain: boolean;
@@ -493,6 +564,8 @@ interface ModuleFeatures {
     crossovers: DrawCrossover[];
     /** Branch endplates — junction connectors off the module (#170). */
     branchConnectors: BranchConnector[];
+    /** Rail-served industries — car-spot spans beside their track (#industries). */
+    industries: DrawIndustry[];
     /** Main 2's extent when it doesn't run the full module — a single↔double
      * transition (Main 2 starts/ends at the mainline turnout). Null = full
      * length (or no Main 2). Renderers draw the partial line + its diverge. */
@@ -598,4 +671,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BenchworkPoint, 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 ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_SCALE_RATIO, type OutlineFace, 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, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, scaleFeetToInches, stateToDoc };
+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, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, type GeometryType, type IndustryLabelMode, 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 SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, scaleFeetToInches, stateToDoc };

package/dist/index.d.ts

@@ -132,6 +132,35 @@ interface SchematicControlPoint {
     crossings?: string[];
     signals?: SchematicSignal[];
 }
+/** What a rendered industry shows beside its name: a car count, a length in
+ * inches, or nothing (name only). Authored per industry. */
+type IndustryLabelMode = "none" | "cars" | "inches";
+/**
+ * An industry — a rail-served customer that spots cars, authored as a SPAN on a
+ * track (a spur/siding, or the main). Positional like everything else: it lives
+ * in the same module-local inch frame and is rendered into the shared 2-D view,
+ * offset to `side`. The span length gives its car capacity; the dispatcher and
+ * crews read where cars set out. Mirrors a `freemon_industries` row.
+ */
+interface SchematicIndustry {
+    id: string;
+    name: string;
+    /** Industry type value from the lookup (e.g. "team_track", "grain"). */
+    type?: string | null;
+    /** The track this industry spots cars on (a spur/siding id, or the main). */
+    track: string;
+    /** The car-spot span along that track, inches from endplate A. */
+    fromPos: number;
+    toPos: number;
+    /** Which side of the track the building + label sit on. */
+    side?: SignalSide;
+    /** Secondary readout at the label — a car count, a length, or none. */
+    labelMode?: IndustryLabelMode;
+    /** Car types this industry receives (car-type value strings). */
+    carTypes?: string[];
+    /** The `freemon_industries` row this is (single source of truth); null = new. */
+    moduleIndustryId?: number | null;
+}
 interface ModuleSchematicDoc {
     version: number;
     module?: string;
@@ -156,6 +185,8 @@ interface ModuleSchematicDoc {
     /** Grade crossings / diamonds (#170). */
     crossings?: SchematicCrossing[];
     controlPoints?: SchematicControlPoint[];
+    /** Rail-served industries — car-spot spans on a track (#industries). */
+    industries?: SchematicIndustry[];
     /** Benchwork FOOTPRINT outline — the module's physical board shape as a
      * polygon in module-local inches, in the same frame as the endplate poses
      * (endplate A's track point at the origin, the mainline along +x, perpendicular
@@ -243,6 +274,13 @@ declare const N_SCALE_RATIO = 160;
 declare function inchesToScaleFeet(inches: number, ratio?: number): number;
 /** Scale feet of prototype track → real inches on the module. */
 declare function scaleFeetToInches(feet: number, ratio?: number): number;
+/** Length a spotted car occupies on N-scale track, inches. A 40-ft car body is
+ * ~3.0″; ~3.3″ over the couplers — the real spacing a cut of cars takes. The
+ * single constant every repo reads so a track's car count matches everywhere. */
+declare const N_CAR_LENGTH_INCHES = 3.3;
+/** How many cars fit in a span, from its drawn length — the derived capacity a
+ * siding or an industry spot holds (never typed). */
+declare function carCapacity(fromPos: number, toPos: number, carLengthInches?: number): number;
 /** Parse a jsonb value into a schematic doc, or null if it isn't one. */
 declare function asModuleSchematic(x: unknown): ModuleSchematicDoc | null;
 interface EditorTrack {
@@ -294,6 +332,20 @@ interface EditorCrossing {
     trackA: string;
     trackB: string;
 }
+/** An industry as the authoring form binds it — a car-spot span on a track. */
+interface EditorIndustry {
+    id: string;
+    name: string;
+    type: string;
+    track: string;
+    fromPos: number;
+    toPos: number;
+    side: SignalSide;
+    labelMode: IndustryLabelMode;
+    carTypes: string[];
+    /** freemon_industries row (single source of truth), or null for a new one. */
+    moduleIndustryId: number | null;
+}
 /** A 3rd+ endplate — a branch/junction connection off the module (#170).
  * A module may have several (e.g. a set carrying a second railroad through:
  * MoPac enters at one branch endplate and leaves at another). */
@@ -339,6 +391,8 @@ interface EditorState {
      * Empty = no authored outline (fall back to the endplate-width band). */
     outline: BenchworkPoint[];
     controlPoints: EditorControlPoint[];
+    /** Rail-served industries — car-spot spans on a track (#industries). */
+    industries: EditorIndustry[];
 }
 /** Build the empty editor state for a module of the given length. */
 declare function emptyEditorState(lengthInches: number): EditorState;
@@ -469,6 +523,23 @@ interface BranchConnector {
     posFrac: number;
     side: "up" | "down";
 }
+/** An industry — draw a car-spot span beside its track's lane, on `side`, with
+ * a name label + an optional car/length readout (#industries). */
+interface DrawIndustry {
+    id: string;
+    name: string;
+    type: string | null;
+    /** Span as fractions of module length (sorted West→East). */
+    fromFrac: number;
+    toFrac: number;
+    /** Lane of the track it spots on, so it draws beside the right track. */
+    lane: number;
+    side: SignalSide;
+    labelMode: IndustryLabelMode;
+    /** Cars that spot here, derived from the drawn span length. */
+    cars: number;
+    carTypes: string[];
+}
 interface ModuleFeatures {
     /** Whether either endplate declares a double-track main. */
     doubleMain: boolean;
@@ -493,6 +564,8 @@ interface ModuleFeatures {
     crossovers: DrawCrossover[];
     /** Branch endplates — junction connectors off the module (#170). */
     branchConnectors: BranchConnector[];
+    /** Rail-served industries — car-spot spans beside their track (#industries). */
+    industries: DrawIndustry[];
     /** Main 2's extent when it doesn't run the full module — a single↔double
      * transition (Main 2 starts/ends at the mainline turnout). Null = full
      * length (or no Main 2). Renderers draw the partial line + its diverge. */
@@ -598,4 +671,4 @@ declare function poseOverridesFromDoc(doc: ModuleSchematicDoc): Record<string, {
     heading: number;
 }>;
 
-export { type BenchworkPoint, 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 ModuleFootprint, type ModuleFootprintInput, type ModuleGeometryInput, type ModuleSchematicDoc, type ModuleTrackRow, N_SCALE_RATIO, type OutlineFace, 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, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, scaleFeetToInches, stateToDoc };
+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, FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, type GeometryType, type IndustryLabelMode, 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 SchematicSignal, type SchematicTrack, type SchematicTurnout, type SignalFacing, type SignalSide, type TrackConfig, type TrackRole, type TurnoutKind, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, scaleFeetToInches, stateToDoc };

package/dist/index.js

@@ -147,6 +147,11 @@ function inchesToScaleFeet(inches, ratio = N_SCALE_RATIO) {
 function scaleFeetToInches(feet, ratio = N_SCALE_RATIO) {
   return feet * 12 / ratio;
 }
+var N_CAR_LENGTH_INCHES = 3.3;
+function carCapacity(fromPos, toPos, carLengthInches = N_CAR_LENGTH_INCHES) {
+  if (!(carLengthInches > 0)) return 0;
+  return Math.max(0, Math.floor(Math.abs(toPos - fromPos) / carLengthInches));
+}
 function asModuleSchematic(x) {
   if (!x || typeof x !== "object") return null;
   const d = x;
@@ -168,7 +173,8 @@ function emptyEditorState(lengthInches) {
     poseOverrides: {},
     endplateWidths: {},
     outline: [],
-    controlPoints: []
+    controlPoints: [],
+    industries: []
   };
 }
 function isTransitionTurnout(t) {
@@ -338,6 +344,21 @@ function stateToDoc(state, recordNumber) {
         side: s.side
       }))
     })),
+    // Industries — car-spot spans on a track; only when any are authored.
+    ...state.industries.length > 0 ? {
+      industries: state.industries.map((ind) => ({
+        id: ind.id,
+        name: ind.name,
+        ...ind.type ? { type: ind.type } : {},
+        track: ind.track,
+        fromPos: ind.fromPos,
+        toPos: ind.toPos,
+        side: ind.side,
+        ...ind.labelMode && ind.labelMode !== "none" ? { labelMode: ind.labelMode } : {},
+        ...ind.carTypes.length ? { carTypes: ind.carTypes } : {},
+        moduleIndustryId: ind.moduleIndustryId
+      }))
+    } : {},
     // Benchwork footprint outline (module-local inches); only when it's a real
     // ring (≥ 3 vertices).
     ...state.outline.length >= 3 ? { outline: state.outline } : {}
@@ -451,7 +472,19 @@ function docToState(doc, fallbackLength, moduleTracks = []) {
       divergeTrack: t.divergeTrack,
       kind: t.kind ?? "right"
     })),
-    controlPoints: readControlPoints(d, sc)
+    controlPoints: readControlPoints(d, sc),
+    industries: (d.industries ?? []).map((ind) => ({
+      id: ind.id,
+      name: ind.name ?? "",
+      type: ind.type ?? "",
+      track: ind.track,
+      fromPos: sc(ind.fromPos ?? 0),
+      toPos: ind.toPos != null ? sc(ind.toPos) : len,
+      side: ind.side ?? "above",
+      labelMode: ind.labelMode ?? "none",
+      carTypes: Array.isArray(ind.carTypes) ? ind.carTypes : [],
+      moduleIndustryId: ind.moduleIndustryId ?? null
+    }))
   };
 }
 function readControlPoints(d, sc = (p) => p) {
@@ -750,6 +783,22 @@ function moduleFeatures(doc) {
     posFrac: clampFrac(e.at.pos),
     side: e.at.side === "down" ? "down" : "up"
   }));
+  const industries = (doc.industries ?? []).map((ind) => {
+    const from = ind.fromPos ?? 0;
+    const to = ind.toPos ?? len;
+    return {
+      id: ind.id,
+      name: ind.name ?? "",
+      type: ind.type ?? null,
+      fromFrac: clampFrac(Math.min(from, to)),
+      toFrac: clampFrac(Math.max(from, to)),
+      lane: trackLane.get(ind.track) ?? 0,
+      side: ind.side ?? "above",
+      labelMode: ind.labelMode ?? "none",
+      cars: carCapacity(from, to),
+      carTypes: Array.isArray(ind.carTypes) ? ind.carTypes : []
+    };
+  });
   const allLanes = [
     0,
     doubleMain ? 1 : 0,
@@ -790,6 +839,7 @@ function moduleFeatures(doc) {
     crossings,
     crossovers,
     branchConnectors,
+    industries,
     laneMin: Math.min(...allLanes),
     laneMax: Math.max(...allLanes)
   };
@@ -892,6 +942,6 @@ function poseOverridesFromDoc(doc) {
   return out;
 }
 
-export { FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, MAIN2_TRACK_ID, MAIN_TRACK_ID, N_SCALE_RATIO, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, scaleFeetToInches, stateToDoc };
+export { FREEMO_ENDPLATE_WIDTH_MIN_INCHES, FREEMO_ENDPLATE_WIDTH_RECOMMENDED_INCHES, MAIN2_TRACK_ID, MAIN_TRACK_ID, N_CAR_LENGTH_INCHES, N_SCALE_RATIO, asModuleSchematic, benchworkBand, benchworkOutline, buildCrossover, buildPassingSiding, buildTransition, carCapacity, deriveEndplatePoses, divergeSideForHand, docToState, emptyEditorState, endplateFaceSegments, endplateWidthInches, geometryTurnDegrees, inchesToScaleFeet, isLoopDoc, isTransitionTurnout, moduleCenterline, moduleFeatures, moduleFootprint, nextId, poseNeedsManual, poseOverridesFromDoc, sampleBenchworkOutline, scaleFeetToInches, stateToDoc };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map