openskidata-format 5.2.0 → 5.3.0

package/src/SlopeGradingScale.ts

@@ -0,0 +1,66 @@
+import { RunDifficulty, RunFeature, RunUse } from "./Run";
+
+/**
+ * Represents a slope grading scale with steepness thresholds for different run types.
+ * Used to estimate run difficulty based on slope steepness. Each scale defines
+ * threshold points where the difficulty classification changes based on gradient.
+ */
+export type SlopeGradingScale = {
+  /** Stops must be ordered ascending by steepness */
+  stops: { maxSteepness: number; difficulty: RunDifficulty | null }[];
+};
+
+/**
+ * Gets the appropriate slope grading scale for a run based on its use types.
+ * Different run uses (downhill, nordic, etc.) have different steepness thresholds
+ * for difficulty classification due to the nature of the activity and equipment used.
+ * 
+ * @param feature - The run feature to get the grading scale for
+ * @returns The appropriate slope grading scale with steepness thresholds
+ */
+export function getSlopeGradingScale(feature: RunFeature): SlopeGradingScale {
+  if (
+    feature.properties.uses.includes(RunUse.Downhill) ||
+    feature.properties.uses.includes(RunUse.Skitour)
+  ) {
+    return {
+      stops: [
+        { maxSteepness: 0.05, difficulty: null }, // No difficulty below 5%
+        { maxSteepness: 0.25, difficulty: RunDifficulty.EASY },
+        { maxSteepness: 0.4, difficulty: RunDifficulty.INTERMEDIATE },
+        { maxSteepness: 0.8, difficulty: RunDifficulty.ADVANCED }, // Advanced up to 80%
+        { maxSteepness: 1.2, difficulty: RunDifficulty.EXPERT }, // Expert up to 120%
+      ],
+    };
+  } else if (feature.properties.uses.includes(RunUse.Nordic)) {
+    return {
+      stops: [
+        { maxSteepness: 0.1, difficulty: RunDifficulty.EASY },
+        { maxSteepness: 0.15, difficulty: RunDifficulty.INTERMEDIATE },
+        { maxSteepness: 0.3, difficulty: RunDifficulty.ADVANCED },
+      ],
+    };
+  } else {
+    return { stops: [] };
+  }
+}
+
+/**
+ * Estimates the run difficulty based on steepness and the provided slope grading scale.
+ * Uses the absolute value of steepness to handle both uphill and downhill slopes.
+ * Finds the first threshold that the steepness falls under.
+ * 
+ * @param steepness - The steepness value (slope gradient as a decimal, e.g., 0.1 = 10%)
+ * @param scale - The slope grading scale with steepness thresholds
+ * @returns The estimated difficulty based on steepness, or null if no match or below minimum threshold
+ */
+export function getEstimatedRunDifficulty(
+  steepness: number,
+  scale: SlopeGradingScale
+): RunDifficulty | null {
+  const absoluteSteepness = Math.abs(steepness);
+  return (
+    scale.stops.find((stop) => stop.maxSteepness > absoluteSteepness)
+      ?.difficulty || null
+  );
+}

package/src/index.ts

@@ -4,6 +4,8 @@ export * from './Lift'
 export * from './LiftNameFormatter'
 export * from './Location'
 export * from './Run'
+export * from './RunDifficultyConvention'
+export * from './SlopeGradingScale'
 export * from './SkiArea'
 export * from './SnowCoverHistory'
 export * from './Source'