@willcgage/module-schematic 0.75.0 → 0.76.0

package/dist/index.cjs

@@ -31,10 +31,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]));
@@ -627,6 +645,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);
@@ -2446,6 +2500,8 @@ exports.TIE_HALF_LENGTH_INCHES = TIE_HALF_LENGTH_INCHES;
 exports.TURNOUT_LEAD_INCHES_PER_FROG = TURNOUT_LEAD_INCHES_PER_FROG;
 exports.WHOLE_MODULE_SECTION_ID = WHOLE_MODULE_SECTION_ID;
 exports.asModuleSchematic = asModuleSchematic;
+exports.assessSectionEnd = assessSectionEnd;
+exports.assessSectionJoint = assessSectionJoint;
 exports.benchworkBand = benchworkBand;
 exports.benchworkOutline = benchworkOutline;
 exports.buildCrossover = buildCrossover;