suunto-api-wrapper 1.1.2 → 1.2.0

package/README.md

@@ -82,6 +82,7 @@ payload, typed to the real API response shape (an envelope of
 | ------------------ | ------------------------------ | ----------------------------------------- |
 | `suunto.workouts`  | `.own(params?)`                | your own workouts                         |
 |                    | `.public(username, params?)`   | a user's public workouts                  |
+|                    | `.byKey(username, key, params?)` | a single workout (public, or your own when authed) |
 | `suunto.users`     | `.byName(username)`            | a user's public profile                   |
 |                    | `.search(terms)`               | search for users                          |
 | `suunto.gear`      | `.latest(username, params?)`   | a user's latest gear                      |
@@ -90,6 +91,7 @@ payload, typed to the real API response shape (an envelope of
 // Workouts
 const own         = await suunto.workouts.own({ limit: 20, offset: 0, since: 0 });
 const publicItems = await suunto.workouts.public("someuser", { limit: 40 });
+const single      = await suunto.workouts.byKey("someuser", "workoutKey123");
 
 // Users
 const profile = await suunto.users.byName("someuser");

package/dist/index.d.mts

@@ -95,6 +95,30 @@ interface GetOwnWorkoutsParams {
     offset?: number;
     limit?: number;
 }
+/** Valid values for the `extensions` query param on the single-workout endpoint. */
+declare enum WorkoutExtensionName {
+    Dive = "DiveExtension",
+    JumpRope = "JumpRopeExtension",
+    Summary = "SummaryExtension",
+    Swimming = "SwimmingExtension",
+    Weather = "WeatherExtension",
+    Workout = "WorkoutExtension",
+    CompetitionHeader = "CompetitionHeaderExtension"
+}
+/** Valid values for the `additionalData` query param on the single-workout endpoint. */
+declare enum WorkoutAdditionalData {
+    Achievements = "achievements",
+    Photos = "photos",
+    Videos = "videos",
+    Comments = "comments",
+    UserReacted = "user_reacted"
+}
+interface GetWorkoutParams {
+    /** Extensions to include in the response. Defaults to `[Summary, CompetitionHeader]`. */
+    extensions?: WorkoutExtensionName[];
+    /** Extra data blocks to include. Defaults to all five values. */
+    additionalData?: WorkoutAdditionalData[];
+}
 /** GPS coordinate: x = longitude, y = latitude. */
 interface Position {
     x: number;
@@ -355,6 +379,11 @@ interface WorkoutsResponse {
         until: string;
     };
 }
+interface WorkoutResponse {
+    error: string | null;
+    payload: Workout;
+    metadata: Record<string, unknown>;
+}
 
 declare function getWorkouts(client: HttpClient, username: string, params?: GetWorkoutsParams): Promise<WorkoutsResponse>;
 declare function getOwnWorkouts(client: HttpClient, params?: GetOwnWorkoutsParams): Promise<WorkoutsResponse>;
@@ -366,6 +395,11 @@ declare class WorkoutsResource {
     own(params?: GetOwnWorkoutsParams): Promise<WorkoutsResponse>;
     /** A given user's public workouts. */
     public(username: string, params?: GetWorkoutsParams): Promise<WorkoutsResponse>;
+    /**
+     * 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: string, workoutKey: string, params?: GetWorkoutParams): Promise<WorkoutResponse>;
 }
 
 interface UserProfile {

package/dist/index.d.ts

@@ -95,6 +95,30 @@ interface GetOwnWorkoutsParams {
     offset?: number;
     limit?: number;
 }
+/** Valid values for the `extensions` query param on the single-workout endpoint. */
+declare enum WorkoutExtensionName {
+    Dive = "DiveExtension",
+    JumpRope = "JumpRopeExtension",
+    Summary = "SummaryExtension",
+    Swimming = "SwimmingExtension",
+    Weather = "WeatherExtension",
+    Workout = "WorkoutExtension",
+    CompetitionHeader = "CompetitionHeaderExtension"
+}
+/** Valid values for the `additionalData` query param on the single-workout endpoint. */
+declare enum WorkoutAdditionalData {
+    Achievements = "achievements",
+    Photos = "photos",
+    Videos = "videos",
+    Comments = "comments",
+    UserReacted = "user_reacted"
+}
+interface GetWorkoutParams {
+    /** Extensions to include in the response. Defaults to `[Summary, CompetitionHeader]`. */
+    extensions?: WorkoutExtensionName[];
+    /** Extra data blocks to include. Defaults to all five values. */
+    additionalData?: WorkoutAdditionalData[];
+}
 /** GPS coordinate: x = longitude, y = latitude. */
 interface Position {
     x: number;
@@ -355,6 +379,11 @@ interface WorkoutsResponse {
         until: string;
     };
 }
+interface WorkoutResponse {
+    error: string | null;
+    payload: Workout;
+    metadata: Record<string, unknown>;
+}
 
 declare function getWorkouts(client: HttpClient, username: string, params?: GetWorkoutsParams): Promise<WorkoutsResponse>;
 declare function getOwnWorkouts(client: HttpClient, params?: GetOwnWorkoutsParams): Promise<WorkoutsResponse>;
@@ -366,6 +395,11 @@ declare class WorkoutsResource {
     own(params?: GetOwnWorkoutsParams): Promise<WorkoutsResponse>;
     /** A given user's public workouts. */
     public(username: string, params?: GetWorkoutsParams): Promise<WorkoutsResponse>;
+    /**
+     * 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: string, workoutKey: string, params?: GetWorkoutParams): Promise<WorkoutResponse>;
 }
 
 interface UserProfile {

package/dist/index.js

@@ -291,6 +291,17 @@ function sessionTokenFrom(response) {
 }
 
 // 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(
@@ -310,6 +321,22 @@ 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;
+}
 var WorkoutsResource = class {
   constructor(client) {
     this.client = client;
@@ -322,6 +349,13 @@ 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);
+  }
 };
 
 // src/users/index.ts

package/dist/index.mjs

@@ -249,6 +249,17 @@ function sessionTokenFrom(response) {
 }
 
 // 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 +279,22 @@ 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;
+}
 var WorkoutsResource = class {
   constructor(client) {
     this.client = client;
@@ -280,6 +307,13 @@ 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);
+  }
 };
 
 // src/users/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "suunto-api-wrapper",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "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"