suunto-api-wrapper 1.1.2 → 1.2.2

package/dist/index.mjs

@@ -248,7 +248,143 @@ function sessionTokenFrom(response) {
   return response.sessionkey;
 }
 
+// src/workouts/types.ts
+var SuuntoActivityType = /* @__PURE__ */ ((SuuntoActivityType2) => {
+  SuuntoActivityType2[SuuntoActivityType2["WALKING"] = 0] = "WALKING";
+  SuuntoActivityType2[SuuntoActivityType2["RUNNING"] = 1] = "RUNNING";
+  SuuntoActivityType2[SuuntoActivityType2["CYCLING"] = 2] = "CYCLING";
+  SuuntoActivityType2[SuuntoActivityType2["CROSS_COUNTRY_SKIING"] = 3] = "CROSS_COUNTRY_SKIING";
+  SuuntoActivityType2[SuuntoActivityType2["OTHER_1"] = 4] = "OTHER_1";
+  SuuntoActivityType2[SuuntoActivityType2["OTHER_2"] = 5] = "OTHER_2";
+  SuuntoActivityType2[SuuntoActivityType2["OTHER_3"] = 6] = "OTHER_3";
+  SuuntoActivityType2[SuuntoActivityType2["OTHER_4"] = 7] = "OTHER_4";
+  SuuntoActivityType2[SuuntoActivityType2["OTHER_5"] = 8] = "OTHER_5";
+  SuuntoActivityType2[SuuntoActivityType2["OTHER_6"] = 9] = "OTHER_6";
+  SuuntoActivityType2[SuuntoActivityType2["MOUNTAIN_BIKING"] = 10] = "MOUNTAIN_BIKING";
+  SuuntoActivityType2[SuuntoActivityType2["HIKING"] = 11] = "HIKING";
+  SuuntoActivityType2[SuuntoActivityType2["ROLLER_SKATING"] = 12] = "ROLLER_SKATING";
+  SuuntoActivityType2[SuuntoActivityType2["DOWNHILL_SKIING"] = 13] = "DOWNHILL_SKIING";
+  SuuntoActivityType2[SuuntoActivityType2["PADDLING"] = 14] = "PADDLING";
+  SuuntoActivityType2[SuuntoActivityType2["ROWING"] = 15] = "ROWING";
+  SuuntoActivityType2[SuuntoActivityType2["GOLF"] = 16] = "GOLF";
+  SuuntoActivityType2[SuuntoActivityType2["INDOOR"] = 17] = "INDOOR";
+  SuuntoActivityType2[SuuntoActivityType2["PARKOUR"] = 18] = "PARKOUR";
+  SuuntoActivityType2[SuuntoActivityType2["BALLGAMES"] = 19] = "BALLGAMES";
+  SuuntoActivityType2[SuuntoActivityType2["OUTDOOR_GYM"] = 20] = "OUTDOOR_GYM";
+  SuuntoActivityType2[SuuntoActivityType2["SWIMMING"] = 21] = "SWIMMING";
+  SuuntoActivityType2[SuuntoActivityType2["TRAIL_RUNNING"] = 22] = "TRAIL_RUNNING";
+  SuuntoActivityType2[SuuntoActivityType2["GYM"] = 23] = "GYM";
+  SuuntoActivityType2[SuuntoActivityType2["NORDIC_WALKING"] = 24] = "NORDIC_WALKING";
+  SuuntoActivityType2[SuuntoActivityType2["HORSEBACK_RIDING"] = 25] = "HORSEBACK_RIDING";
+  SuuntoActivityType2[SuuntoActivityType2["MOTOR_SPORTS"] = 26] = "MOTOR_SPORTS";
+  SuuntoActivityType2[SuuntoActivityType2["SKATEBOARDING"] = 27] = "SKATEBOARDING";
+  SuuntoActivityType2[SuuntoActivityType2["WATER_SPORTS"] = 28] = "WATER_SPORTS";
+  SuuntoActivityType2[SuuntoActivityType2["CLIMBING"] = 29] = "CLIMBING";
+  SuuntoActivityType2[SuuntoActivityType2["SNOWBOARDING"] = 30] = "SNOWBOARDING";
+  SuuntoActivityType2[SuuntoActivityType2["SKI_TOURING"] = 31] = "SKI_TOURING";
+  SuuntoActivityType2[SuuntoActivityType2["FITNESS_CLASS"] = 32] = "FITNESS_CLASS";
+  SuuntoActivityType2[SuuntoActivityType2["SOCCER"] = 33] = "SOCCER";
+  SuuntoActivityType2[SuuntoActivityType2["TENNIS"] = 34] = "TENNIS";
+  SuuntoActivityType2[SuuntoActivityType2["BASKETBALL"] = 35] = "BASKETBALL";
+  SuuntoActivityType2[SuuntoActivityType2["BADMINTON"] = 36] = "BADMINTON";
+  SuuntoActivityType2[SuuntoActivityType2["BASEBALL"] = 37] = "BASEBALL";
+  SuuntoActivityType2[SuuntoActivityType2["VOLLEYBALL"] = 38] = "VOLLEYBALL";
+  SuuntoActivityType2[SuuntoActivityType2["AMERICAN_FOOTBALL"] = 39] = "AMERICAN_FOOTBALL";
+  SuuntoActivityType2[SuuntoActivityType2["TABLE_TENNIS"] = 40] = "TABLE_TENNIS";
+  SuuntoActivityType2[SuuntoActivityType2["RACQUETBALL"] = 41] = "RACQUETBALL";
+  SuuntoActivityType2[SuuntoActivityType2["SQUASH"] = 42] = "SQUASH";
+  SuuntoActivityType2[SuuntoActivityType2["FLOORBALL"] = 43] = "FLOORBALL";
+  SuuntoActivityType2[SuuntoActivityType2["HANDBALL"] = 44] = "HANDBALL";
+  SuuntoActivityType2[SuuntoActivityType2["SOFTBALL"] = 45] = "SOFTBALL";
+  SuuntoActivityType2[SuuntoActivityType2["BOWLING"] = 46] = "BOWLING";
+  SuuntoActivityType2[SuuntoActivityType2["CRICKET"] = 47] = "CRICKET";
+  SuuntoActivityType2[SuuntoActivityType2["RUGBY"] = 48] = "RUGBY";
+  SuuntoActivityType2[SuuntoActivityType2["ICE_SKATING"] = 49] = "ICE_SKATING";
+  SuuntoActivityType2[SuuntoActivityType2["ICE_HOCKEY"] = 50] = "ICE_HOCKEY";
+  SuuntoActivityType2[SuuntoActivityType2["YOGA"] = 51] = "YOGA";
+  SuuntoActivityType2[SuuntoActivityType2["INDOOR_CYCLING"] = 52] = "INDOOR_CYCLING";
+  SuuntoActivityType2[SuuntoActivityType2["TREADMILL"] = 53] = "TREADMILL";
+  SuuntoActivityType2[SuuntoActivityType2["CROSSFIT"] = 54] = "CROSSFIT";
+  SuuntoActivityType2[SuuntoActivityType2["CROSSTRAINER"] = 55] = "CROSSTRAINER";
+  SuuntoActivityType2[SuuntoActivityType2["ROLLER_SKIING"] = 56] = "ROLLER_SKIING";
+  SuuntoActivityType2[SuuntoActivityType2["INDOOR_ROWING"] = 57] = "INDOOR_ROWING";
+  SuuntoActivityType2[SuuntoActivityType2["STRETCHING"] = 58] = "STRETCHING";
+  SuuntoActivityType2[SuuntoActivityType2["TRACK_AND_FIELD"] = 59] = "TRACK_AND_FIELD";
+  SuuntoActivityType2[SuuntoActivityType2["ORIENTEERING"] = 60] = "ORIENTEERING";
+  SuuntoActivityType2[SuuntoActivityType2["SUP"] = 61] = "SUP";
+  SuuntoActivityType2[SuuntoActivityType2["COMBAT_SPORTS"] = 62] = "COMBAT_SPORTS";
+  SuuntoActivityType2[SuuntoActivityType2["KETTLEBELL"] = 63] = "KETTLEBELL";
+  SuuntoActivityType2[SuuntoActivityType2["DANCING"] = 64] = "DANCING";
+  SuuntoActivityType2[SuuntoActivityType2["SNOWSHOEING"] = 65] = "SNOWSHOEING";
+  SuuntoActivityType2[SuuntoActivityType2["FRISBEE_GOLF"] = 66] = "FRISBEE_GOLF";
+  SuuntoActivityType2[SuuntoActivityType2["FUTSAL"] = 67] = "FUTSAL";
+  SuuntoActivityType2[SuuntoActivityType2["MULTISPORT"] = 68] = "MULTISPORT";
+  SuuntoActivityType2[SuuntoActivityType2["AEROBICS"] = 69] = "AEROBICS";
+  SuuntoActivityType2[SuuntoActivityType2["TREKKING"] = 70] = "TREKKING";
+  SuuntoActivityType2[SuuntoActivityType2["SAILING"] = 71] = "SAILING";
+  SuuntoActivityType2[SuuntoActivityType2["KAYAKING"] = 72] = "KAYAKING";
+  SuuntoActivityType2[SuuntoActivityType2["CIRCUIT_TRAINING"] = 73] = "CIRCUIT_TRAINING";
+  SuuntoActivityType2[SuuntoActivityType2["TRIATHLON"] = 74] = "TRIATHLON";
+  SuuntoActivityType2[SuuntoActivityType2["PADEL"] = 75] = "PADEL";
+  SuuntoActivityType2[SuuntoActivityType2["CHEERLEADING"] = 76] = "CHEERLEADING";
+  SuuntoActivityType2[SuuntoActivityType2["BOXING"] = 77] = "BOXING";
+  SuuntoActivityType2[SuuntoActivityType2["SCUBADIVING"] = 78] = "SCUBADIVING";
+  SuuntoActivityType2[SuuntoActivityType2["FREEDIVING"] = 79] = "FREEDIVING";
+  SuuntoActivityType2[SuuntoActivityType2["ADVENTURE_RACING"] = 80] = "ADVENTURE_RACING";
+  SuuntoActivityType2[SuuntoActivityType2["GYMNASTICS"] = 81] = "GYMNASTICS";
+  SuuntoActivityType2[SuuntoActivityType2["CANOEING"] = 82] = "CANOEING";
+  SuuntoActivityType2[SuuntoActivityType2["MOUNTAINEERING"] = 83] = "MOUNTAINEERING";
+  SuuntoActivityType2[SuuntoActivityType2["TELEMARKSKIING"] = 84] = "TELEMARKSKIING";
+  SuuntoActivityType2[SuuntoActivityType2["OPENWATER_SWIMMING"] = 85] = "OPENWATER_SWIMMING";
+  SuuntoActivityType2[SuuntoActivityType2["WINDSURFING"] = 86] = "WINDSURFING";
+  SuuntoActivityType2[SuuntoActivityType2["KITESURFING_KITING"] = 87] = "KITESURFING_KITING";
+  SuuntoActivityType2[SuuntoActivityType2["PARAGLIDING"] = 88] = "PARAGLIDING";
+  SuuntoActivityType2[SuuntoActivityType2["SNORKELING"] = 90] = "SNORKELING";
+  SuuntoActivityType2[SuuntoActivityType2["SURFING"] = 91] = "SURFING";
+  SuuntoActivityType2[SuuntoActivityType2["SWIMRUN"] = 92] = "SWIMRUN";
+  SuuntoActivityType2[SuuntoActivityType2["DUATHLON"] = 93] = "DUATHLON";
+  SuuntoActivityType2[SuuntoActivityType2["AQUATHLON"] = 94] = "AQUATHLON";
+  SuuntoActivityType2[SuuntoActivityType2["OBSTACLE_RACING"] = 95] = "OBSTACLE_RACING";
+  SuuntoActivityType2[SuuntoActivityType2["FISHING"] = 96] = "FISHING";
+  SuuntoActivityType2[SuuntoActivityType2["HUNTING"] = 97] = "HUNTING";
+  SuuntoActivityType2[SuuntoActivityType2["GRAVEL_CYCLING"] = 99] = "GRAVEL_CYCLING";
+  SuuntoActivityType2[SuuntoActivityType2["MERMAIDING"] = 100] = "MERMAIDING";
+  SuuntoActivityType2[SuuntoActivityType2["SPEARFISHING"] = 101] = "SPEARFISHING";
+  SuuntoActivityType2[SuuntoActivityType2["JUMP_ROPE"] = 102] = "JUMP_ROPE";
+  SuuntoActivityType2[SuuntoActivityType2["TRACK_RUNNING"] = 103] = "TRACK_RUNNING";
+  SuuntoActivityType2[SuuntoActivityType2["CALISTHENICS"] = 104] = "CALISTHENICS";
+  SuuntoActivityType2[SuuntoActivityType2["E_BIKING"] = 105] = "E_BIKING";
+  SuuntoActivityType2[SuuntoActivityType2["E_MTB"] = 106] = "E_MTB";
+  SuuntoActivityType2[SuuntoActivityType2["BACKCOUNTRY_SKIING"] = 107] = "BACKCOUNTRY_SKIING";
+  SuuntoActivityType2[SuuntoActivityType2["WHEELCHAIR"] = 108] = "WHEELCHAIR";
+  SuuntoActivityType2[SuuntoActivityType2["HAND_CYCLING"] = 109] = "HAND_CYCLING";
+  SuuntoActivityType2[SuuntoActivityType2["SPLIT_BOARDING"] = 110] = "SPLIT_BOARDING";
+  SuuntoActivityType2[SuuntoActivityType2["BIATHLON"] = 111] = "BIATHLON";
+  SuuntoActivityType2[SuuntoActivityType2["MEDITATION"] = 112] = "MEDITATION";
+  SuuntoActivityType2[SuuntoActivityType2["FIELD_HOCKEY"] = 113] = "FIELD_HOCKEY";
+  SuuntoActivityType2[SuuntoActivityType2["CYCLOCROSS"] = 114] = "CYCLOCROSS";
+  SuuntoActivityType2[SuuntoActivityType2["VERTICAL_RUN"] = 115] = "VERTICAL_RUN";
+  SuuntoActivityType2[SuuntoActivityType2["SKI_MOUNTAINEERING"] = 116] = "SKI_MOUNTAINEERING";
+  SuuntoActivityType2[SuuntoActivityType2["SKATE_SKIING"] = 117] = "SKATE_SKIING";
+  SuuntoActivityType2[SuuntoActivityType2["CLASSIC_SKIING"] = 118] = "CLASSIC_SKIING";
+  SuuntoActivityType2[SuuntoActivityType2["CHORES"] = 119] = "CHORES";
+  SuuntoActivityType2[SuuntoActivityType2["PILATES"] = 120] = "PILATES";
+  SuuntoActivityType2[SuuntoActivityType2["NEW_YOGA"] = 121] = "NEW_YOGA";
+  return SuuntoActivityType2;
+})(SuuntoActivityType || {});
+
 // src/workouts/index.ts
+var DEFAULT_WORKOUT_EXTENSIONS = [
+  "SummaryExtension" /* Summary */,
+  "CompetitionHeaderExtension" /* CompetitionHeader */
+];
+var DEFAULT_WORKOUT_ADDITIONAL_DATA = [
+  "achievements" /* Achievements */,
+  "photos" /* Photos */,
+  "videos" /* Videos */,
+  "comments" /* Comments */,
+  "user_reacted" /* UserReacted */
+];
 async function getWorkouts(client, username, params = {}) {
   const { limit = 40, sortonst = true } = params;
   const res = await client.get(
@@ -268,6 +404,44 @@ async function getOwnWorkouts(client, params = {}) {
   );
   return res.data;
 }
+async function getWorkout(client, username, workoutKey, params = {}) {
+  const {
+    extensions = DEFAULT_WORKOUT_EXTENSIONS,
+    additionalData = DEFAULT_WORKOUT_ADDITIONAL_DATA
+  } = params;
+  const res = await client.get(
+    `/apiserver/v2/workouts/${encodeURIComponent(username)}/${encodeURIComponent(workoutKey)}/combined`,
+    {
+      query: {
+        extensions: extensions.join(","),
+        additionalData: additionalData.join(",")
+      }
+    }
+  );
+  return res.data;
+}
+async function getWorkoutsWithin(client, params) {
+  const { lowerLat, lowerLng, upperLat, upperLng, limit = 50 } = params;
+  const res = await client.get(
+    "/apiserver/v1/workouts/public/within",
+    {
+      query: {
+        lowerlat: lowerLat,
+        lowerlng: lowerLng,
+        upperlat: upperLat,
+        upperlng: upperLng,
+        limit
+      }
+    }
+  );
+  return res.data;
+}
+async function getWorkoutStats(client, username) {
+  const res = await client.get(
+    `/apiserver/v1/workouts/${encodeURIComponent(username)}/stats`
+  );
+  return res.data;
+}
 var WorkoutsResource = class {
   constructor(client) {
     this.client = client;
@@ -280,6 +454,24 @@ var WorkoutsResource = class {
   public(username, params) {
     return getWorkouts(this.client, username, params);
   }
+  /**
+   * A single workout by username and workout key. Works for any public workout
+   * and, when the client is authenticated as the owner, for private ones too.
+   */
+  byKey(username, workoutKey, params) {
+    return getWorkout(this.client, username, workoutKey, params);
+  }
+  /**
+   * Aggregated workout stats per activity for the given user. Works
+   * unauthenticated.
+   */
+  stats(username) {
+    return getWorkoutStats(this.client, username);
+  }
+  /** Public workouts whose center falls inside a geographic bounding box. */
+  within(params) {
+    return getWorkoutsWithin(this.client, params);
+  }
 };
 
 // src/users/index.ts
@@ -374,6 +566,7 @@ export {
   HttpClient,
   HttpError,
   SPORTS_TRACKER_API,
+  SuuntoActivityType,
   SuuntoClient,
   UsersResource,
   WorkoutsResource,
@@ -381,7 +574,9 @@ export {
   getLatestGear,
   getOwnWorkouts,
   getUserByName,
+  getWorkoutStats,
   getWorkouts,
+  getWorkoutsWithin,
   login,
   searchUsers,
   secondsUntilRollover,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suunto-api-wrapper",
-  "version": "1.1.2",
+  "version": "1.2.2",
   "description": "Unofficial typed TypeScript client for the Suunto app API (Sports Tracker backend). Not affiliated with or endorsed by Suunto or Sports Tracker.",
   "repository": {
     "url": "https://github.com/Marius-Ar/suunto-api-wrapper"