incyclist-services 1.7.82 → 1.7.83

package/lib/cjs/workouts/ride/page/service.js

@@ -41,11 +41,13 @@ const types_1 = require("../../../base/types");
 const pages_1 = require("../../../base/pages");
 const display_1 = require("../../../ride/display");
 const activities_1 = require("../../../activities");
+const settings_1 = require("../../../settings");
 const service_1 = require("../service");
 const graph_1 = require("../../base/graph");
 const BACKGROUND_PAUSE_TIMEOUT_MS = 300000;
 const UPCOMING_STEPS_COUNT = 3;
 const DEFAULT_LOAD_INCREMENT = 1;
+const HINTS_WORKOUT_GESTURES_KEY = 'hints.workoutRideGestures';
 let WorkoutRidePageService = (() => {
     let _classDecorators = [types_1.Singleton];
     let _classDescriptor;
@@ -56,6 +58,7 @@ let WorkoutRidePageService = (() => {
     let _getRideDisplay_decorators;
     let _getWorkoutRide_decorators;
     let _getActivityRide_decorators;
+    let _getUserSettings_decorators;
     var WorkoutRidePageService = class extends _classSuper {
         static { _classThis = this; }
         static {
@@ -63,9 +66,11 @@ let WorkoutRidePageService = (() => {
             _getRideDisplay_decorators = [decorators_1.Injectable];
             _getWorkoutRide_decorators = [decorators_1.Injectable];
             _getActivityRide_decorators = [decorators_1.Injectable];
+            _getUserSettings_decorators = [decorators_1.Injectable];
             __esDecorate(this, null, _getRideDisplay_decorators, { kind: "method", name: "getRideDisplay", static: false, private: false, access: { has: obj => "getRideDisplay" in obj, get: obj => obj.getRideDisplay }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _getWorkoutRide_decorators, { kind: "method", name: "getWorkoutRide", static: false, private: false, access: { has: obj => "getWorkoutRide" in obj, get: obj => obj.getWorkoutRide }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _getActivityRide_decorators, { kind: "method", name: "getActivityRide", static: false, private: false, access: { has: obj => "getActivityRide" in obj, get: obj => obj.getActivityRide }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(this, null, _getUserSettings_decorators, { kind: "method", name: "getUserSettings", static: false, private: false, access: { has: obj => "getUserSettings" in obj, get: obj => obj.getUserSettings }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
             WorkoutRidePageService = _classThis = _classDescriptor.value;
             if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
@@ -77,6 +82,7 @@ let WorkoutRidePageService = (() => {
         backgroundTimer;
         backgroundPausedByService = false;
         menuProps = null;
+        gestureHintDismissed = false;
         constructor() {
             super('WorkoutRidePage');
             this.rideEventHandler['state-update'] = this.onRideStateUpdate.bind(this);
@@ -91,6 +97,7 @@ let WorkoutRidePageService = (() => {
             try {
                 this.logEvent({ message: 'page shown', page: 'WorkoutRide' });
                 gd_eventlog_1.EventLogger.setGlobalConfig('page', 'WorkoutRide');
+                this.gestureHintDismissed = false;
                 super.openPage();
                 try {
                     const service = this.getRideDisplay();
@@ -162,7 +169,8 @@ let WorkoutRidePageService = (() => {
                     title: wo.title ?? '',
                     graph: this.buildGraphPlan(current, wo.ftp),
                     steps: this.buildUpcomingSteps(current, wo.ftp),
-                    dashboard: this.buildDashboardLine(wo)
+                    dashboard: this.buildDashboardLine(wo),
+                    gestureHint: this.buildGestureHint(base.startOverlayProps === null)
                 };
             }
             catch (err) {
@@ -278,6 +286,18 @@ let WorkoutRidePageService = (() => {
                 this.logError(err, 'onIgnoreStart');
             }
         }
+        onGestureHintDismissed({ dontShowAgain }) {
+            try {
+                this.gestureHintDismissed = true;
+                if (dontShowAgain) {
+                    this.getUserSettings().set(HINTS_WORKOUT_GESTURES_KEY, true);
+                }
+                this.updatePageDisplay();
+            }
+            catch (err) {
+                this.logError(err, 'onGestureHintDismissed');
+            }
+        }
         onCancelStart() {
             try {
                 this.rideObserver?.stop();
@@ -357,6 +377,18 @@ let WorkoutRidePageService = (() => {
                 startGateProps: null
             };
         }
+        buildGestureHint(startOverlayCleared) {
+            if (this.gestureHintDismissed || !startOverlayCleared)
+                return null;
+            if (this.getElapsedActivityTime() !== 0 || this.getCurrentCadence() !== 0)
+                return null;
+            if (this.getUserSettings().get(HINTS_WORKOUT_GESTURES_KEY, false))
+                return null;
+            return { visible: true };
+        }
+        getCurrentCadence() {
+            return this.getActivityRide().getCurrentValues?.()?.cadence ?? 0;
+        }
         buildGraphPlan(current, ftp) {
             if (!current) {
                 return { bars: [], ftp: ftp ?? 0, ftpLine: ftp ?? 0, domain: { x: [0, 0], y: [0, 0] } };
@@ -451,7 +483,8 @@ let WorkoutRidePageService = (() => {
                 title: '',
                 graph: { bars: [], ftp: 0, ftpLine: 0, domain: { x: [0, 0], y: [0, 0] } },
                 steps: { previous: null, current: null, upcoming: [], hasMore: false },
-                dashboard: { text: '', mode: null }
+                dashboard: { text: '', mode: null },
+                gestureHint: null
             };
         }
         updatePageDisplay() {
@@ -481,6 +514,9 @@ let WorkoutRidePageService = (() => {
         getActivityRide() {
             return (0, activities_1.useActivityRide)();
         }
+        getUserSettings() {
+            return (0, settings_1.useUserSettings)();
+        }
     };
     return WorkoutRidePageService = _classThis;
 })();

package/lib/esm/workouts/ride/page/service.js

@@ -38,11 +38,13 @@ import { Singleton } from "../../../base/types";
 import { IncyclistPageService } from "../../../base/pages";
 import { useRideDisplay } from "../../../ride/display";
 import { useActivityRide } from "../../../activities";
+import { useUserSettings } from "../../../settings";
 import { useWorkoutRide } from "../service";
 import { getFlattenedSteps, getStepDuration, getStepTargetText, getWorkoutGraphSeries } from "../../base/graph";
 const BACKGROUND_PAUSE_TIMEOUT_MS = 300000;
 const UPCOMING_STEPS_COUNT = 3;
 const DEFAULT_LOAD_INCREMENT = 1;
+const HINTS_WORKOUT_GESTURES_KEY = 'hints.workoutRideGestures';
 let WorkoutRidePageService = (() => {
     let _classDecorators = [Singleton];
     let _classDescriptor;
@@ -53,6 +55,7 @@ let WorkoutRidePageService = (() => {
     let _getRideDisplay_decorators;
     let _getWorkoutRide_decorators;
     let _getActivityRide_decorators;
+    let _getUserSettings_decorators;
     var WorkoutRidePageService = class extends _classSuper {
         static { _classThis = this; }
         static {
@@ -60,9 +63,11 @@ let WorkoutRidePageService = (() => {
             _getRideDisplay_decorators = [Injectable];
             _getWorkoutRide_decorators = [Injectable];
             _getActivityRide_decorators = [Injectable];
+            _getUserSettings_decorators = [Injectable];
             __esDecorate(this, null, _getRideDisplay_decorators, { kind: "method", name: "getRideDisplay", static: false, private: false, access: { has: obj => "getRideDisplay" in obj, get: obj => obj.getRideDisplay }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _getWorkoutRide_decorators, { kind: "method", name: "getWorkoutRide", static: false, private: false, access: { has: obj => "getWorkoutRide" in obj, get: obj => obj.getWorkoutRide }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _getActivityRide_decorators, { kind: "method", name: "getActivityRide", static: false, private: false, access: { has: obj => "getActivityRide" in obj, get: obj => obj.getActivityRide }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(this, null, _getUserSettings_decorators, { kind: "method", name: "getUserSettings", static: false, private: false, access: { has: obj => "getUserSettings" in obj, get: obj => obj.getUserSettings }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(null, _classDescriptor = { value: _classThis }, _classDecorators, { kind: "class", name: _classThis.name, metadata: _metadata }, null, _classExtraInitializers);
             WorkoutRidePageService = _classThis = _classDescriptor.value;
             if (_metadata) Object.defineProperty(_classThis, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
@@ -74,6 +79,7 @@ let WorkoutRidePageService = (() => {
         backgroundTimer;
         backgroundPausedByService = false;
         menuProps = null;
+        gestureHintDismissed = false;
         constructor() {
             super('WorkoutRidePage');
             this.rideEventHandler['state-update'] = this.onRideStateUpdate.bind(this);
@@ -88,6 +94,7 @@ let WorkoutRidePageService = (() => {
             try {
                 this.logEvent({ message: 'page shown', page: 'WorkoutRide' });
                 EventLogger.setGlobalConfig('page', 'WorkoutRide');
+                this.gestureHintDismissed = false;
                 super.openPage();
                 try {
                     const service = this.getRideDisplay();
@@ -159,7 +166,8 @@ let WorkoutRidePageService = (() => {
                     title: wo.title ?? '',
                     graph: this.buildGraphPlan(current, wo.ftp),
                     steps: this.buildUpcomingSteps(current, wo.ftp),
-                    dashboard: this.buildDashboardLine(wo)
+                    dashboard: this.buildDashboardLine(wo),
+                    gestureHint: this.buildGestureHint(base.startOverlayProps === null)
                 };
             }
             catch (err) {
@@ -275,6 +283,18 @@ let WorkoutRidePageService = (() => {
                 this.logError(err, 'onIgnoreStart');
             }
         }
+        onGestureHintDismissed({ dontShowAgain }) {
+            try {
+                this.gestureHintDismissed = true;
+                if (dontShowAgain) {
+                    this.getUserSettings().set(HINTS_WORKOUT_GESTURES_KEY, true);
+                }
+                this.updatePageDisplay();
+            }
+            catch (err) {
+                this.logError(err, 'onGestureHintDismissed');
+            }
+        }
         onCancelStart() {
             try {
                 this.rideObserver?.stop();
@@ -354,6 +374,18 @@ let WorkoutRidePageService = (() => {
                 startGateProps: null
             };
         }
+        buildGestureHint(startOverlayCleared) {
+            if (this.gestureHintDismissed || !startOverlayCleared)
+                return null;
+            if (this.getElapsedActivityTime() !== 0 || this.getCurrentCadence() !== 0)
+                return null;
+            if (this.getUserSettings().get(HINTS_WORKOUT_GESTURES_KEY, false))
+                return null;
+            return { visible: true };
+        }
+        getCurrentCadence() {
+            return this.getActivityRide().getCurrentValues?.()?.cadence ?? 0;
+        }
         buildGraphPlan(current, ftp) {
             if (!current) {
                 return { bars: [], ftp: ftp ?? 0, ftpLine: ftp ?? 0, domain: { x: [0, 0], y: [0, 0] } };
@@ -448,7 +480,8 @@ let WorkoutRidePageService = (() => {
                 title: '',
                 graph: { bars: [], ftp: 0, ftpLine: 0, domain: { x: [0, 0], y: [0, 0] } },
                 steps: { previous: null, current: null, upcoming: [], hasMore: false },
-                dashboard: { text: '', mode: null }
+                dashboard: { text: '', mode: null },
+                gestureHint: null
             };
         }
         updatePageDisplay() {
@@ -478,6 +511,9 @@ let WorkoutRidePageService = (() => {
         getActivityRide() {
             return useActivityRide();
         }
+        getUserSettings() {
+            return useUserSettings();
+        }
     };
     return WorkoutRidePageService = _classThis;
 })();

package/lib/types/workouts/ride/page/service.d.ts

@@ -4,7 +4,7 @@ import type { CurrentRideState, RideType } from "../../../types";
 import type { WorkoutDisplayProperties } from "../types";
 import type { Workout } from "../../base/model";
 import type { StepDefinition } from "../../base/model/types";
-import type { IWorkoutRidePageService, WorkoutDashboardLine, WorkoutGraphActuals, WorkoutGraphPlan, WorkoutRideMenuProps, WorkoutRidePageDisplayProps, WorkoutUpcomingSteps } from "./types";
+import type { IWorkoutRidePageService, WorkoutDashboardLine, WorkoutGestureHint, WorkoutGraphActuals, WorkoutGraphPlan, WorkoutRideMenuProps, WorkoutRidePageDisplayProps, WorkoutUpcomingSteps } from "./types";
 export declare class WorkoutRidePageService extends IncyclistPageService implements IWorkoutRidePageService {
     protected rideEventHandler: Record<string, any>;
     protected workoutEventHandler: Record<string, any>;
@@ -12,6 +12,7 @@ export declare class WorkoutRidePageService extends IncyclistPageService impleme
     protected backgroundTimer: NodeJS.Timeout | undefined;
     protected backgroundPausedByService: boolean;
     protected menuProps: WorkoutRideMenuProps | null;
+    protected gestureHintDismissed: boolean;
     constructor();
     openPage(simulate?: boolean): IObserver;
     closePage(): void;
@@ -31,6 +32,9 @@ export declare class WorkoutRidePageService extends IncyclistPageService impleme
     onDecreaseLoad(): void;
     onRetryStart(): void;
     onIgnoreStart(): void;
+    onGestureHintDismissed({ dontShowAgain }: {
+        dontShowAgain: boolean;
+    }): void;
     onCancelStart(): void;
     adjustLoad(deltaPct: number): void;
     protected onRideStateUpdate(state: CurrentRideState): void;
@@ -47,6 +51,8 @@ export declare class WorkoutRidePageService extends IncyclistPageService impleme
         menuProps: WorkoutRideMenuProps;
         startGateProps: any;
     };
+    protected buildGestureHint(startOverlayCleared: boolean): WorkoutGestureHint | null;
+    protected getCurrentCadence(): number;
     protected buildGraphPlan(current: Workout | undefined, ftp: number): WorkoutGraphPlan;
     protected buildUpcomingSteps(current: Workout | undefined, ftp: number): WorkoutUpcomingSteps;
     protected buildDashboardLine(wo: WorkoutDisplayProperties): WorkoutDashboardLine;
@@ -65,5 +71,6 @@ export declare class WorkoutRidePageService extends IncyclistPageService impleme
     protected getRideDisplay(): import("../../../ride/display").RideDisplayService;
     protected getWorkoutRide(): import("../service").WorkoutRide;
     protected getActivityRide(): import("../../../activities").ActivityRideService;
+    protected getUserSettings(): import("../../../settings").UserSettingsService;
 }
 export declare const getWorkoutRidePageService: () => WorkoutRidePageService;

package/lib/types/workouts/ride/page/types.d.ts

@@ -42,12 +42,16 @@ export interface WorkoutRideMenuProps {
     canStepBack: boolean;
     canStepForward: boolean;
 }
+export interface WorkoutGestureHint {
+    visible: boolean;
+}
 export interface WorkoutRidePageDisplayProps extends RidePageDisplayProps {
     menuProps: WorkoutRideMenuProps | null;
     graph: WorkoutGraphPlan;
     steps: WorkoutUpcomingSteps;
     dashboard: WorkoutDashboardLine;
     title: string;
+    gestureHint: WorkoutGestureHint | null;
 }
 export interface WorkoutRidePageCallbacks {
     onMenuOpen(): void;
@@ -62,6 +66,9 @@ export interface WorkoutRidePageCallbacks {
     onRetryStart(): void;
     onIgnoreStart(): void;
     onCancelStart(): void;
+    onGestureHintDismissed(props: {
+        dontShowAgain: boolean;
+    }): void;
 }
 export interface IWorkoutRidePageService extends WorkoutRidePageCallbacks, IPageService {
     getRideObserver(): IObserver | null;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "incyclist-services",
-  "version": "1.7.82",
+  "version": "1.7.83",
   "peerDependencies": {
     "gd-eventlog": "^0.1.27"
   },
   "dependencies": {
     "@garmin/fitsdk": "^21.200.0",
     "axios": "^1.15.2",
-    "incyclist-devices": "^3.0.23",
+    "incyclist-devices": "^3.0.24",
     "promise.any": "^2.0.6",
     "semver": "^7.7.4",
     "tcx-builder": "^1.1.1",