incyclist-services 1.7.124 → 1.7.126

package/lib/cjs/api/bindings/index.js

@@ -59,6 +59,7 @@ let IncyclistBindings = (() => {
         downloadManager;
         form;
         secret;
+        mapAvailability;
         mq;
         ui;
         settings;

package/lib/cjs/api/mapAvailability/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/ride/route/GpxDisplayService.js

@@ -46,6 +46,7 @@ const SV_UPDATE_FREQ = 3000;
 const SV_MIN_READY = 1500;
 const SV_MIN_DELAY = 1000;
 const SV_START_TIMEOUT = 15000;
+const SAT_START_TIMEOUT = 15000;
 let GpxDisplayService = (() => {
     let _classSuper = RouteDisplayService_1.RouteDisplayService;
     let _instanceExtraInitializers = [];
@@ -76,6 +77,8 @@ let GpxDisplayService = (() => {
         updateDurations = [];
         svStartTimedOut = false;
         svStartTimeout;
+        satStartTimedOut = false;
+        satStartTimeout;
         constructor() {
             super();
         }
@@ -90,6 +93,10 @@ let GpxDisplayService = (() => {
                     if (this.waitsForStreetView())
                         this.armStreetViewStartTimeout();
                 }
+                else if (rideView === 'sat') {
+                    if (this.waitsForSatelliteView())
+                        this.armSatelliteViewStartTimeout();
+                }
             }
             catch (err) {
                 this.logError(err, 'initView');
@@ -114,7 +121,12 @@ let GpxDisplayService = (() => {
             return props;
         }
         getInitialStreetViewPosition() {
-            const position = this.position;
+            return this.enrichWithHeading(this.position, 'getInitialStreetViewPosition');
+        }
+        getSatelliteViewPosition() {
+            return this.enrichWithHeading(this.position, 'getSatelliteViewPosition');
+        }
+        enrichWithHeading(position, logContext) {
             if (!position)
                 return undefined;
             if (position.heading !== undefined)
@@ -123,17 +135,20 @@ let GpxDisplayService = (() => {
                 return { ...position, heading: (0, routes_1.getHeading)(this.getOriginalRoute(), position) };
             }
             catch (err) {
-                this.logError(err, 'getInitialStreetViewPosition');
+                this.logError(err, logContext);
                 return position;
             }
         }
         waitsForStreetView() {
             return this.isMobile() && this.getRideSettingsDisplay().getRideView() === 'sv';
         }
+        waitsForSatelliteView() {
+            return this.isMobile() && this.getRideSettingsDisplay().getRideView() === 'sat';
+        }
         getSatelliteViewProps() {
             return {
                 onDisplayEvent: this.onSatelliteViewEvent.bind(this),
-                displayPosition: this.position
+                displayPosition: this.getSatelliteViewPosition()
             };
         }
         getMapViewProps() {
@@ -145,7 +160,7 @@ let GpxDisplayService = (() => {
         }
         getStartOverlayProps() {
             const rideView = this.getRideSettingsDisplay().getRideView();
-            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView())) {
+            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView() && !this.waitsForSatelliteView())) {
                 return {
                     mapType: this.getRideViewName(),
                     mapState: 'Loaded'
@@ -159,11 +174,11 @@ let GpxDisplayService = (() => {
         }
         isStartRideCompleted() {
             const rideView = this.getRideSettingsDisplay().getRideView();
-            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView())) {
+            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView() && !this.waitsForSatelliteView())) {
                 this.mapLoaded = true;
                 return true;
             }
-            if (this.svStartTimedOut)
+            if (this.svStartTimedOut || this.satStartTimedOut)
                 return true;
             return this.mapLoaded;
         }
@@ -199,6 +214,7 @@ let GpxDisplayService = (() => {
         onSatelliteViewEvent(state, error) {
             if (state === 'Loaded') {
                 this.mapLoaded = true;
+                this.clearSatelliteViewStartTimeout();
             }
             else if (state === 'Error') {
                 this.logEvent({ message: 'sat view error', error: this.mapError });
@@ -288,12 +304,35 @@ let GpxDisplayService = (() => {
         getStreetViewStartTimeout() {
             return this.getNumSetting('SV_START_TIMEOUT') ?? SV_START_TIMEOUT;
         }
+        armSatelliteViewStartTimeout() {
+            this.clearSatelliteViewStartTimeout();
+            const timeout = this.getSatelliteViewStartTimeout();
+            this.satStartTimeout = setTimeout(() => {
+                this.satStartTimeout = undefined;
+                if (this.mapLoaded)
+                    return;
+                this.satStartTimedOut = true;
+                this.logEvent({ message: 'satellite view start timeout', timeout });
+                this.emit('state-update');
+            }, timeout);
+        }
+        clearSatelliteViewStartTimeout() {
+            if (this.satStartTimeout) {
+                clearTimeout(this.satStartTimeout);
+                this.satStartTimeout = undefined;
+            }
+        }
+        getSatelliteViewStartTimeout() {
+            return this.getNumSetting('SAT_START_TIMEOUT') ?? SAT_START_TIMEOUT;
+        }
         onStarted() {
             this.clearStreetViewStartTimeout();
+            this.clearSatelliteViewStartTimeout();
             super.onStarted();
         }
         async stop() {
             this.clearStreetViewStartTimeout();
+            this.clearSatelliteViewStartTimeout();
             return super.stop();
         }
         getStreetViewObserver() {

package/lib/cjs/routes/list/cards/RouteCard.js

@@ -416,6 +416,8 @@ let RouteCard = (() => {
         }
         updateStartPos(p, data) {
             const [C, U] = (0, i18n_1.getUnitConversionShortcuts)();
+            if (p === undefined || p === null)
+                return null;
             let value;
             if (typeof p === 'number')
                 value = p;

package/lib/cjs/settings/display/ride/service.js

@@ -40,6 +40,10 @@ const decorators_1 = require("../../../base/decorators");
 const service_1 = require("../../../base/service");
 const types_1 = require("../../../base/types");
 const service_2 = require("../../service");
+const UNAVAILABLE_MESSAGES = {
+    'need.playservices': 'Install Google Play Services to use this view',
+};
+const DEFAULT_UNAVAILABLE_MESSAGE = 'This view is currently unavailable on your device';
 let RideSettingsDisplayService = (() => {
     let _classDecorators = [decorators_1.Singleton];
     let _classDescriptor;
@@ -83,8 +87,6 @@ let RideSettingsDisplayService = (() => {
             };
         }
         setRideView(rideView) {
-            if (this.isRestricted())
-                return;
             try {
                 this.getUserSettings().set('preferences.rideView', rideView);
             }
@@ -97,29 +99,29 @@ let RideSettingsDisplayService = (() => {
                 this.observer.emit('changed', this.getDisplayProps());
         }
         getRideView() {
-            if (this.isRestricted())
-                return 'map';
             const rideView = this.getUserSettings().get('preferences.rideView', 'sv');
+            const availability = this.getBindings().mapAvailability?.isAvailable(rideView);
+            if (availability?.status === 'unavailable' || availability?.status === 'not-supported')
+                return 'map';
             return rideView;
         }
         getRideViewOptions() {
             const map = new Map();
-            if (this.isRestricted()) {
-                map.set('map', 'Map');
-                return map;
-            }
-            map.set('sv', 'Street View');
-            map.set('map', 'Map');
-            if (!this.isMobile())
-                map.set('sat', 'Satellite View');
+            this.addRideViewOption(map, 'sv', 'Street View');
+            map.set('map', { label: 'Map' });
+            this.addRideViewOption(map, 'sat', 'Satellite View');
             return map;
         }
-        isRestricted() {
-            if (this.isMobile()) {
-                const secretsStatus = this.getSecretBinding()?.getSecretsStatus?.();
-                return (secretsStatus === 'stale' || secretsStatus === 'missing' || secretsStatus === undefined);
+        addRideViewOption(map, key, label) {
+            const availability = this.getBindings().mapAvailability?.isAvailable(key);
+            if (availability?.status === 'not-supported')
+                return;
+            if (availability?.status === 'unavailable') {
+                const message = UNAVAILABLE_MESSAGES[availability.messageKey ?? ''] ?? DEFAULT_UNAVAILABLE_MESSAGE;
+                map.set(key, { label, disabled: true, message });
+                return;
             }
-            return false;
+            map.set(key, { label });
         }
         isMobile() {
             return this.getBindings().appInfo?.getChannel() === 'mobile';
@@ -136,9 +138,6 @@ let RideSettingsDisplayService = (() => {
         getBindings() {
             return (0, api_1.getBindings)();
         }
-        getSecretBinding() {
-            return this.getBindings().secret;
-        }
     };
     return RideSettingsDisplayService = _classThis;
 })();

package/lib/esm/api/bindings/index.js

@@ -56,6 +56,7 @@ let IncyclistBindings = (() => {
         downloadManager;
         form;
         secret;
+        mapAvailability;
         mq;
         ui;
         settings;

package/lib/esm/api/mapAvailability/types.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/ride/route/GpxDisplayService.js

@@ -43,6 +43,7 @@ const SV_UPDATE_FREQ = 3000;
 const SV_MIN_READY = 1500;
 const SV_MIN_DELAY = 1000;
 const SV_START_TIMEOUT = 15000;
+const SAT_START_TIMEOUT = 15000;
 let GpxDisplayService = (() => {
     let _classSuper = RouteDisplayService;
     let _instanceExtraInitializers = [];
@@ -73,6 +74,8 @@ let GpxDisplayService = (() => {
         updateDurations = [];
         svStartTimedOut = false;
         svStartTimeout;
+        satStartTimedOut = false;
+        satStartTimeout;
         constructor() {
             super();
         }
@@ -87,6 +90,10 @@ let GpxDisplayService = (() => {
                     if (this.waitsForStreetView())
                         this.armStreetViewStartTimeout();
                 }
+                else if (rideView === 'sat') {
+                    if (this.waitsForSatelliteView())
+                        this.armSatelliteViewStartTimeout();
+                }
             }
             catch (err) {
                 this.logError(err, 'initView');
@@ -111,7 +118,12 @@ let GpxDisplayService = (() => {
             return props;
         }
         getInitialStreetViewPosition() {
-            const position = this.position;
+            return this.enrichWithHeading(this.position, 'getInitialStreetViewPosition');
+        }
+        getSatelliteViewPosition() {
+            return this.enrichWithHeading(this.position, 'getSatelliteViewPosition');
+        }
+        enrichWithHeading(position, logContext) {
             if (!position)
                 return undefined;
             if (position.heading !== undefined)
@@ -120,17 +132,20 @@ let GpxDisplayService = (() => {
                 return { ...position, heading: getHeading(this.getOriginalRoute(), position) };
             }
             catch (err) {
-                this.logError(err, 'getInitialStreetViewPosition');
+                this.logError(err, logContext);
                 return position;
             }
         }
         waitsForStreetView() {
             return this.isMobile() && this.getRideSettingsDisplay().getRideView() === 'sv';
         }
+        waitsForSatelliteView() {
+            return this.isMobile() && this.getRideSettingsDisplay().getRideView() === 'sat';
+        }
         getSatelliteViewProps() {
             return {
                 onDisplayEvent: this.onSatelliteViewEvent.bind(this),
-                displayPosition: this.position
+                displayPosition: this.getSatelliteViewPosition()
             };
         }
         getMapViewProps() {
@@ -142,7 +157,7 @@ let GpxDisplayService = (() => {
         }
         getStartOverlayProps() {
             const rideView = this.getRideSettingsDisplay().getRideView();
-            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView())) {
+            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView() && !this.waitsForSatelliteView())) {
                 return {
                     mapType: this.getRideViewName(),
                     mapState: 'Loaded'
@@ -156,11 +171,11 @@ let GpxDisplayService = (() => {
         }
         isStartRideCompleted() {
             const rideView = this.getRideSettingsDisplay().getRideView();
-            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView())) {
+            if (rideView === 'map' || (this.isMobile() && !this.waitsForStreetView() && !this.waitsForSatelliteView())) {
                 this.mapLoaded = true;
                 return true;
             }
-            if (this.svStartTimedOut)
+            if (this.svStartTimedOut || this.satStartTimedOut)
                 return true;
             return this.mapLoaded;
         }
@@ -196,6 +211,7 @@ let GpxDisplayService = (() => {
         onSatelliteViewEvent(state, error) {
             if (state === 'Loaded') {
                 this.mapLoaded = true;
+                this.clearSatelliteViewStartTimeout();
             }
             else if (state === 'Error') {
                 this.logEvent({ message: 'sat view error', error: this.mapError });
@@ -285,12 +301,35 @@ let GpxDisplayService = (() => {
         getStreetViewStartTimeout() {
             return this.getNumSetting('SV_START_TIMEOUT') ?? SV_START_TIMEOUT;
         }
+        armSatelliteViewStartTimeout() {
+            this.clearSatelliteViewStartTimeout();
+            const timeout = this.getSatelliteViewStartTimeout();
+            this.satStartTimeout = setTimeout(() => {
+                this.satStartTimeout = undefined;
+                if (this.mapLoaded)
+                    return;
+                this.satStartTimedOut = true;
+                this.logEvent({ message: 'satellite view start timeout', timeout });
+                this.emit('state-update');
+            }, timeout);
+        }
+        clearSatelliteViewStartTimeout() {
+            if (this.satStartTimeout) {
+                clearTimeout(this.satStartTimeout);
+                this.satStartTimeout = undefined;
+            }
+        }
+        getSatelliteViewStartTimeout() {
+            return this.getNumSetting('SAT_START_TIMEOUT') ?? SAT_START_TIMEOUT;
+        }
         onStarted() {
             this.clearStreetViewStartTimeout();
+            this.clearSatelliteViewStartTimeout();
             super.onStarted();
         }
         async stop() {
             this.clearStreetViewStartTimeout();
+            this.clearSatelliteViewStartTimeout();
             return super.stop();
         }
         getStreetViewObserver() {

package/lib/esm/routes/list/cards/RouteCard.js

@@ -413,6 +413,8 @@ let RouteCard = (() => {
         }
         updateStartPos(p, data) {
             const [C, U] = getUnitConversionShortcuts();
+            if (p === undefined || p === null)
+                return null;
             let value;
             if (typeof p === 'number')
                 value = p;

package/lib/esm/settings/display/ride/service.js

@@ -37,6 +37,10 @@ import { Injectable, Singleton } from "../../../base/decorators";
 import { IncyclistService } from "../../../base/service";
 import { Observer } from "../../../base/types";
 import { useUserSettings } from "../../service";
+const UNAVAILABLE_MESSAGES = {
+    'need.playservices': 'Install Google Play Services to use this view',
+};
+const DEFAULT_UNAVAILABLE_MESSAGE = 'This view is currently unavailable on your device';
 let RideSettingsDisplayService = (() => {
     let _classDecorators = [Singleton];
     let _classDescriptor;
@@ -80,8 +84,6 @@ let RideSettingsDisplayService = (() => {
             };
         }
         setRideView(rideView) {
-            if (this.isRestricted())
-                return;
             try {
                 this.getUserSettings().set('preferences.rideView', rideView);
             }
@@ -94,29 +96,29 @@ let RideSettingsDisplayService = (() => {
                 this.observer.emit('changed', this.getDisplayProps());
         }
         getRideView() {
-            if (this.isRestricted())
-                return 'map';
             const rideView = this.getUserSettings().get('preferences.rideView', 'sv');
+            const availability = this.getBindings().mapAvailability?.isAvailable(rideView);
+            if (availability?.status === 'unavailable' || availability?.status === 'not-supported')
+                return 'map';
             return rideView;
         }
         getRideViewOptions() {
             const map = new Map();
-            if (this.isRestricted()) {
-                map.set('map', 'Map');
-                return map;
-            }
-            map.set('sv', 'Street View');
-            map.set('map', 'Map');
-            if (!this.isMobile())
-                map.set('sat', 'Satellite View');
+            this.addRideViewOption(map, 'sv', 'Street View');
+            map.set('map', { label: 'Map' });
+            this.addRideViewOption(map, 'sat', 'Satellite View');
             return map;
         }
-        isRestricted() {
-            if (this.isMobile()) {
-                const secretsStatus = this.getSecretBinding()?.getSecretsStatus?.();
-                return (secretsStatus === 'stale' || secretsStatus === 'missing' || secretsStatus === undefined);
+        addRideViewOption(map, key, label) {
+            const availability = this.getBindings().mapAvailability?.isAvailable(key);
+            if (availability?.status === 'not-supported')
+                return;
+            if (availability?.status === 'unavailable') {
+                const message = UNAVAILABLE_MESSAGES[availability.messageKey ?? ''] ?? DEFAULT_UNAVAILABLE_MESSAGE;
+                map.set(key, { label, disabled: true, message });
+                return;
             }
-            return false;
+            map.set(key, { label });
         }
         isMobile() {
             return this.getBindings().appInfo?.getChannel() === 'mobile';
@@ -133,9 +135,6 @@ let RideSettingsDisplayService = (() => {
         getBindings() {
             return getBindings();
         }
-        getSecretBinding() {
-            return this.getBindings().secret;
-        }
     };
     return RideSettingsDisplayService = _classThis;
 })();

package/lib/types/api/bindings/index.d.ts

@@ -12,6 +12,7 @@ import type { ISecretBinding } from '../secret';
 import type { ISerialBinding } from '../serial/types';
 import type { ICryptoBinding } from '../crypto/types';
 import type { IFetchBinding } from '../fetch/types';
+import type { IMapAvailabilityBinding } from '../mapAvailability/types';
 export interface IUserSettingsBinding {
     getAll(): Promise<any>;
     set(key: string, value: any): Promise<boolean>;
@@ -28,6 +29,7 @@ export declare class IncyclistBindings {
     downloadManager?: IDownloadManager;
     form?: IFormPostBinding;
     secret?: ISecretBinding;
+    mapAvailability?: IMapAvailabilityBinding;
     mq: IMessageQueueBinding;
     ui: INativeUI;
     settings: IUserSettingsBinding;

package/lib/types/api/mapAvailability/types.d.ts

@@ -0,0 +1,10 @@
+import type { TRideView } from '../../settings/display/ride/types';
+export type AvailabilityStatus = 'available' | 'unavailable' | 'not-supported';
+export interface AvailabilityResult {
+    status: AvailabilityStatus;
+    messageKey?: string;
+}
+export interface IMapAvailabilityBinding {
+    isAvailable(key: TRideView): AvailabilityResult;
+    onChange(cb: (key: TRideView, result: AvailabilityResult) => void): void;
+}

package/lib/types/api/types.d.ts

@@ -6,3 +6,4 @@ export type * from './video';
 export type * from './crypto/types';
 export type * from './fetch/types';
 export type * from './bindings/types';
+export type * from './mapAvailability/types';

package/lib/types/ride/route/GpxDisplayService.d.ts

@@ -2,7 +2,7 @@ import { GoogleMapsService } from "../../apps";
 import { Observer } from "../../base/types";
 import { Route } from "../../routes/base/model/route";
 import { RoutePoint } from "../../types";
-import { CurrentRideDisplayProps, GpxDisplayProps } from "../base";
+import { CurrentPosition, CurrentRideDisplayProps, GpxDisplayProps } from "../base";
 import { RouteDisplayService } from "./RouteDisplayService";
 import { SatelliteViewEvent, StreetViewEvent } from "./types";
 export declare class GpxDisplayService extends RouteDisplayService {
@@ -23,19 +23,24 @@ export declare class GpxDisplayService extends RouteDisplayService {
     protected updateDurations: Array<number>;
     protected svStartTimedOut: boolean;
     protected svStartTimeout: NodeJS.Timeout;
+    protected satStartTimedOut: boolean;
+    protected satStartTimeout: NodeJS.Timeout;
     constructor();
     protected initView(): void;
     getStreetViewProps(rideProps: CurrentRideDisplayProps): any;
-    protected getInitialStreetViewPosition(): import("../base").CurrentPosition;
+    protected getInitialStreetViewPosition(): CurrentPosition;
+    protected getSatelliteViewPosition(): CurrentPosition;
+    protected enrichWithHeading(position: CurrentPosition | undefined, logContext: string): CurrentPosition;
     protected waitsForStreetView(): boolean;
+    protected waitsForSatelliteView(): boolean;
     getSatelliteViewProps(): {
         onDisplayEvent: any;
-        displayPosition: import("../base").CurrentPosition;
+        displayPosition: CurrentPosition;
     };
     getMapViewProps(): {
         onDisplayEvent: any;
         showMap: boolean;
-        displayPosition: import("../base").CurrentPosition;
+        displayPosition: CurrentPosition;
     };
     getStartOverlayProps(): {
         mapType: string;
@@ -57,6 +62,9 @@ export declare class GpxDisplayService extends RouteDisplayService {
     protected armStreetViewStartTimeout(): void;
     protected clearStreetViewStartTimeout(): void;
     protected getStreetViewStartTimeout(): number;
+    protected armSatelliteViewStartTimeout(): void;
+    protected clearSatelliteViewStartTimeout(): void;
+    protected getSatelliteViewStartTimeout(): number;
     onStarted(): void;
     stop(): Promise<void>;
     protected getStreetViewObserver(): Observer;

package/lib/types/settings/display/ride/service.d.ts

@@ -1,9 +1,8 @@
-import { ISecretBinding } from "../../../api";
 import { IncyclistService } from "../../../base/service";
 import { Observer } from "../../../base/types";
 import { IObserver } from "../../../types";
 import { UserSettingsService } from "../../service";
-import { RideSettingsDisplayProps, TRideView } from "./types";
+import { RideSettingsDisplayProps, TRideView, TRideViewOption } from "./types";
 export declare class RideSettingsDisplayService extends IncyclistService {
     protected observer: Observer;
     constructor();
@@ -13,13 +12,12 @@ export declare class RideSettingsDisplayService extends IncyclistService {
     setRideView(rideView: TRideView): void;
     protected emitChanged(): void;
     getRideView(): TRideView;
-    getRideViewOptions(): Map<TRideView, string>;
-    protected isRestricted(): boolean;
+    getRideViewOptions(): Map<TRideView, TRideViewOption>;
+    protected addRideViewOption(map: Map<TRideView, TRideViewOption>, key: TRideView, label: string): void;
     protected isMobile(): boolean;
     protected isAndroid(): boolean;
     protected isIOS(): boolean;
     protected getUserSettings(): UserSettingsService;
     protected getBindings(): import("../../../api").IncyclistBindings;
-    protected getSecretBinding(): ISecretBinding | undefined;
 }
 export declare const useRideSettingsDisplay: () => RideSettingsDisplayService;

package/lib/types/settings/display/ride/types.d.ts

@@ -1,5 +1,10 @@
 export type TRideView = 'sv' | 'sat' | 'map';
+export interface TRideViewOption {
+    label: string;
+    disabled?: boolean;
+    message?: string;
+}
 export interface RideSettingsDisplayProps {
     rideView: TRideView;
-    rideViewOptions: Map<TRideView, string>;
+    rideViewOptions: Map<TRideView, TRideViewOption>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "incyclist-services",
-  "version": "1.7.124",
+  "version": "1.7.126",
   "peerDependencies": {
     "gd-eventlog": "^0.1.27"
   },