@willcgage/module-schematic 0.95.0 → 0.95.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -223,6 +223,24 @@ interface SchematicTrack {
223
223
  * fouling the track. Absent = derive it from the clearance points (#19). */
224
224
  measuredUsableInches?: number | null;
225
225
  }
226
+ /**
227
+ * A turnout.
228
+ *
229
+ * ⭐ **THE WORD IS "TURNOUT", NOT "SWITCH".** They were used interchangeably
230
+ * across both apps; this is the one name. The Free-moN standard says turnout
231
+ * ("main-line turnouts at least #6") and so does the NMRA, every user-facing
232
+ * string already said it, and "switch" is ambiguous three ways for us — the
233
+ * points assembly, an electrical switch, and *switching*, the operation of
234
+ * moving cars, which we need as its own word.
235
+ *
236
+ * ⚠️ TWO DELIBERATE EXCEPTIONS, both still correct usage:
237
+ * 1. **A manufacturer's own product name, quoted as they sell it.** Atlas sells
238
+ * a "#7 LH Switch" (2052). Renaming their product makes it un-findable in a
239
+ * catalogue, which is the opposite of what a parts library is for.
240
+ * 2. **The points assembly and its geometry** — "switch points", and the
241
+ * "switch angle" that {@link TurnoutClosure.switchSlope} carries. That is a
242
+ * part OF a turnout, not another word FOR one.
243
+ */
226
244
  interface SchematicTurnout {
227
245
  id: string;
228
246
  pos: number;
@@ -1340,7 +1358,7 @@ declare function docToState(doc: unknown, fallbackLength: number, moduleTracks?:
1340
1358
  /** Find an unused `${prefix}${n}` id given the ones already present. */
1341
1359
  declare function nextId(prefix: string, existing: string[]): string;
1342
1360
  /**
1343
- * Build a passing siding as one unit: the siding track, a switch at each end,
1361
+ * Build a passing siding as one unit: the siding track, a turnout at each end,
1344
1362
  * and control-point signals for both directions at each end (prototype Station
1345
1363
  * Entering Signal). Returns the new items to merge into the editor state.
1346
1364
  */
package/dist/index.d.ts CHANGED
@@ -223,6 +223,24 @@ interface SchematicTrack {
223
223
  * fouling the track. Absent = derive it from the clearance points (#19). */
224
224
  measuredUsableInches?: number | null;
225
225
  }
226
+ /**
227
+ * A turnout.
228
+ *
229
+ * ⭐ **THE WORD IS "TURNOUT", NOT "SWITCH".** They were used interchangeably
230
+ * across both apps; this is the one name. The Free-moN standard says turnout
231
+ * ("main-line turnouts at least #6") and so does the NMRA, every user-facing
232
+ * string already said it, and "switch" is ambiguous three ways for us — the
233
+ * points assembly, an electrical switch, and *switching*, the operation of
234
+ * moving cars, which we need as its own word.
235
+ *
236
+ * ⚠️ TWO DELIBERATE EXCEPTIONS, both still correct usage:
237
+ * 1. **A manufacturer's own product name, quoted as they sell it.** Atlas sells
238
+ * a "#7 LH Switch" (2052). Renaming their product makes it un-findable in a
239
+ * catalogue, which is the opposite of what a parts library is for.
240
+ * 2. **The points assembly and its geometry** — "switch points", and the
241
+ * "switch angle" that {@link TurnoutClosure.switchSlope} carries. That is a
242
+ * part OF a turnout, not another word FOR one.
243
+ */
226
244
  interface SchematicTurnout {
227
245
  id: string;
228
246
  pos: number;
@@ -1340,7 +1358,7 @@ declare function docToState(doc: unknown, fallbackLength: number, moduleTracks?:
1340
1358
  /** Find an unused `${prefix}${n}` id given the ones already present. */
1341
1359
  declare function nextId(prefix: string, existing: string[]): string;
1342
1360
  /**
1343
- * Build a passing siding as one unit: the siding track, a switch at each end,
1361
+ * Build a passing siding as one unit: the siding track, a turnout at each end,
1344
1362
  * and control-point signals for both directions at each end (prototype Station
1345
1363
  * Entering Signal). Returns the new items to merge into the editor state.
1346
1364
  */