@windycom/plugin-devtools 2.0.0 → 3.0.0

package/types/client/d.ts.files/broadcast.d.ts

@@ -12,16 +12,19 @@ import { DetailLocChangeParams } from '@plugins/detail/detail.d';
 import { ParsLocation as GlobeParsLocation } from '@plugins/globe/main/receiver.d';
 import { Params as GlobeParams, Poi as GlobePoi } from '@plugins/globe/types.d';
 import { ExtendedDataAndParams } from '@plugins/isolines/IsolinesCanvas2D.d';
-import { ClientMessage, DownloadProgress, ServiceWorkerMessage } from '@plugins/offline/offline';
 import { Evented } from '@windy/Evented';
 import { MetricIdent, MetricItem } from '@windy/Metric.d';
 import { PluginIdent } from '@windy/Plugin';
 import { NotificationPreferences } from '@windy/dataSpecifications.d';
-import { Fav, GeolocationInfo, LatLon, WeatherParameters } from '@windy/interfaces.d';
+import { GeolocationInfo, LatLon, WeatherParameters } from '@windy/interfaces.d';
 import { PluginSource, PluginsOpenParams, PluginsQsParams } from '@windy/plugin-params.d';
 import { Plugins } from '@windy/plugins.d';
 import { Pois } from '@windy/rootScope.d';
 import type { ExternalPluginIdent } from '@windy/types';
+import type { CenterOptions } from '@windy/map';
+import type { AnimationOptions, FitBoundsOptions, LngLatBoundsLike } from '@windycom/maplibre-gl';
+import type { ViewportBounds } from '@plugins/_shared/maplibre/utils/maplibreUtils';
+import type { RadarPlusLayer } from '@plugins/radar-plus/types';
 
 type BcastTypesNonGeneric = {
     /**
@@ -74,9 +77,12 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     /** Plugin was successfully loaded and closed */
     pluginClosed: [PluginIdent | string];
 
-    /** Plugin was succesfully closed */
+    /** Plugin was successfully closed */
     pluginOpened: [PluginIdent | string];
 
+    /** Svelte plugin was successfully mounted */
+    pluginMounted: [PluginIdent | string];
+
     /**
      * Triggered when Windy has successfully loaded and rendered requested data.
      * Use this for triggering your own tasks.
@@ -101,9 +107,12 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
      */
     metricChanged: [MetricIdent | undefined, MetricItem | undefined];
 
-    /** Indicates that user added, remover or rename his fav @ignore */
+    /** Indicates that user added, remover or rename his fav  */
     favChanged: [];
 
+    /** Indicates that user added, remover or rename his alert  */
+    alertChanged: [];
+
     /**
      * Indicates, that router has parsed URL and launched plugin
      * that was requested in URL
@@ -114,15 +123,37 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     /** @ignore */ globeOpened: [];
     /** @ignore */ globeClose: [];
     /** @ignore */ globeFailed: [];
+
     /** @ignore */ 'globe-detail': [DetailLocChangeParams | (LatLon & PluginSource)];
     /** @ignore */ 'globe-isolines': [ExtendedDataAndParams | null];
     /** @ignore */ 'globe-poi': [GlobeParsLocation & { type?: string; id?: string }];
     /** @ignore */ 'globe-zoomIn': [[number, number] | null] | [];
     /** @ignore */ 'globe-zoomOut': [[number, number] | null] | [];
     /** @ignore */ 'globe-paramsChanged': [GlobeParams];
-    /** @ignore */ 'maps-zoomIn': [number | undefined, L.ZoomOptions | undefined];
-    /** @ignore */ 'maps-zoomOut': [number | undefined, L.ZoomOptions | undefined];
-    /** @ignore */ 'maps-paramsChanged': [WeatherParameters, keyof WeatherParameters | undefined];
+
+    /** @ignore */ 'leaflet-zoomIn': [number | undefined, L.ZoomOptions | undefined];
+    /** @ignore */ 'leaflet-zoomOut': [number | undefined, L.ZoomOptions | undefined];
+    /** @ignore */ 'leaflet-paramsChanged': [
+        WeatherParameters,
+        keyof WeatherParameters | undefined,
+    ];
+
+    /** @ignore */ 'maplibre-zoomIn': [AnimationOptions | undefined, unknown | undefined];
+    /** @ignore */ 'maplibre-zoomOut': [AnimationOptions | undefined, unknown | undefined];
+    /** @ignore */ 'maplibre-setZoom': [number, unknown | undefined];
+    /** @ignore */ 'maplibre-centerMap': [CenterOptions];
+    /** @ignore */ 'maplibre-triggerDragging': [boolean];
+    /** @ignore */ 'maplibre-fitBounds': [LngLatBoundsLike, FitBoundsOptions | undefined];
+    /** @ignore */ 'maplibre-panToOffset': [number, number, number];
+    /** @ignore */ 'maplibre-ensurePointVisibleY': [number, number, number];
+    /** @ignore */ 'maplibre-moveEnd': [];
+    /** @ignore */ 'maplibre-zoomChange': [number];
+    /** @ignore */ 'maplibre-boundsChange': [ViewportBounds];
+    /** @ignore */ 'maplibre-paramsChanged': [
+        WeatherParameters,
+        keyof WeatherParameters | undefined,
+    ];
+    /** @ignore */ 'radarPlus-open-layer': [RadarPlusLayer, boolean | undefined]; // Layer to open, whether to open layer for color editing
     /** @ignore */ detailClose: [];
     /** @ignore */ detailRendered: []; // used only in embed2
     /** @ignore */ reloadFavs: [];
@@ -132,7 +163,6 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     /** @ignore */ screenshotReady: [];
     /** @ignore */ screenshotError: [Error];
     /** @ignore */ onResume: [];
-    /** @ignore */ cloudSync: ['error', { data: Fav | string; action: string; type: 'fav' }];
     /** @ignore */ back2home: [];
     /** @ignore */ reloadMobileApp: [];
     /** @ignore */ newLocation: [GeolocationInfo];
@@ -145,8 +175,6 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     /** @ignore */ openCapAlerts: [PluginsOpenParams['picker']];
     /** @ignore */ openapp: [];
     /** @ignore */ openSearch: [];
-    /** @ignore */ offlineNativeMessage: [ClientMessage];
-    /** @ignore */ offlineClientMessage: [ServiceWorkerMessage | { data: DownloadProgress }];
 }
 
 interface BcastTypes<T extends keyof Plugins> extends BcastTypesNonGeneric, BasicBcastTypes<T> {}

package/types/client/d.ts.files/dataSpecifications.d.ts

@@ -1,5 +1,4 @@
 import {
-    AcTimes,
     GlobalPointProducts,
     Isolines,
     Levels,
@@ -26,17 +25,20 @@ import {
     ShowableError,
     SubTier,
     Timestamp,
+    type Hours,
     type RouteMotionSpeed,
+    type UsedMapLibrary,
+    type UserInterest,
 } from '@windy/types.d';
 
-import { ColorGradient } from '@windy/Color.d';
-
 import { MetricItem } from '@windy/Metric.d';
 
+import type { User, LoginAndFinishAction } from '@windy/user.d';
+
 import type { SubscriptionInfo } from '@plugins/_shared/subscription-services/subscription-services.d';
-import type { DownloadedInfo, OfflineConfiguration } from '@plugins/offline/offline.d';
 import type RadarCalendar from '@plugins/radar/calendar/RadarCalendar';
 import type SatelliteCalendar from '@plugins/satellite/calendar/SatelliteCalendar';
+import type { NumberRange } from './alerts';
 
 /**
  * Custom animation particles settings
@@ -54,6 +56,9 @@ export interface CustomParticles {
  */
 export interface NotificationPreferences {
     email?: string;
+    preferredNotificationTime?: NumberRange[];
+    frequencyDays?: number;
+    usedTimezoneName?: string;
     sendToEmail: boolean;
     sendToMobile: boolean;
 }
@@ -77,21 +82,6 @@ export interface Donation {
     sub: string;
 }
 
-export interface User {
-    avatar?: string;
-    email?: string;
-    fullname?: string;
-    id: number;
-    username: string;
-    userslug: string;
-    verifiedEmail?: string;
-
-    /**
-     * Based on user location, cookie consent can be shown to the user if needed
-     */
-    requiresCookieConsent?: boolean;
-}
-
 export interface MapCoordinates extends LatLon {
     source: 'maps' | 'globe';
     zoom: number;
@@ -150,12 +140,6 @@ export interface DataSpecificationsObject<T> {
      */
     update?: Timestamp;
 
-    /**
-     * Allow overwrite start-up URL
-     * TODO: Refactor. Used only once in router.ts
-     */
-    allowUrlRewrite?: boolean;
-
     /**
      * Setter function (will be run before value is set)
      */
@@ -176,7 +160,6 @@ export interface DataSpecificationsObject<T> {
  *  `overlay`,
  *  `level`,
  *  `availLevels`,
- *  `acTime`,
  *  `timestamp`,
  *  `isolines`,
  *  `product`,
@@ -206,9 +189,9 @@ export interface DataSpecifications {
     level: DataSpecificationsObject<Levels>;
 
     /**
-     * Rain/snow accumulated time range. Use `store.getAllowed('acTime')` to get list of allowed values.
+     * Rain/snow/wind accumulations time range in hours
      */
-    acTime: DataSpecificationsObject<AcTimes>;
+    acRange: DataSpecificationsObject<Hours>;
 
     /**
      * Timestamp of actual weather moment. Use freely and without hesitation. Must be valid timestamp in ms, that is
@@ -229,9 +212,14 @@ export interface DataSpecifications {
     path: DataSpecificationsObject<Path>;
 
     /**
-     * Read only value! UTC string containing time of actually rendered data that are available for current overlay and weather model.
+     * Which type of isolines to render
      */
-    isolines: DataSpecificationsObject<Isolines>;
+    isolinesType: DataSpecificationsObject<Isolines>;
+
+    /**
+     * Whether to render isolines
+     */
+    isolinesOn: DataSpecificationsObject<boolean>;
 
     /**
      * Product is set of weather data, that have same resolution, boundaries, time range and so on.
@@ -250,11 +238,6 @@ export interface DataSpecifications {
      */
     visibleProducts: DataSpecificationsObject<Products[]>;
 
-    /**
-     * Available accumulation times for give overlay and product combination
-     */
-    availAcTimes: DataSpecificationsObject<AcTimes[]>;
-
     /**
      * Global fallback product that handles situation
      * when user pans the map out of bounds of local
@@ -330,15 +313,22 @@ export interface DataSpecifications {
     isImperial: DataSpecificationsObject<boolean>;
 
     /**
-     * Type of map shown in detail
+     * Type of map tiles map shown in detail
      */
     map: DataSpecificationsObject<'sznmap' | 'sat' | 'winter'>;
 
+    /**
+     * Which type of map library is used
+     */
+    mapLibrary: DataSpecificationsObject<UsedMapLibrary>;
+
     /**
      * Show 7 days weather on startup
      */
     showWeather: DataSpecificationsObject<boolean>;
 
+    stormSettingsLightning: DataSpecificationsObject<boolean>;
+
     /**
      * Is WebGL disabled?
      */
@@ -354,6 +344,11 @@ export interface DataSpecifications {
      */
     usedLang: DataSpecificationsObject<SupportedLanguages>;
 
+    /**
+     * The difference in minutes between UTC and the local time on the device.
+     */
+    lastTimezoneOffset: DataSpecificationsObject<number>;
+
     /**
      * Particles animation settings
      */
@@ -411,11 +406,6 @@ export interface DataSpecifications {
      */
     startupReverseName: DataSpecificationsObject<ReverseResult | null>;
 
-    /**
-     * NOTAMs marked as read
-     */
-    notams: DataSpecificationsObject<Record<string, number> | null>;
-
     /**
      * Users email
      */
@@ -431,6 +421,11 @@ export interface DataSpecifications {
      */
     displayHeliports: DataSpecificationsObject<boolean>;
 
+    /**
+     * Display Airspaces map layer in the METARs POI layer
+     */
+    displayAirspaces: DataSpecificationsObject<boolean>;
+
     /**
      * User statistics
      * @ignore
@@ -449,17 +444,11 @@ export interface DataSpecifications {
      */
     seenRadarInfo: DataSpecificationsObject<boolean>;
 
-    /**
-     * Wheather picker was dragged or not (not settings but info)
-     * @ignore
-     */
-    wasDragged: DataSpecificationsObject<boolean>;
-
     /**
      * Detail's location - TODO: get rid of async name property
      * @ignore
      */
-    detailLocation: DataSpecificationsObject<(LatLon & { name?: string }) | null>;
+    detailLocation: DataSpecificationsObject<(LatLon & { name?: string; id?: string }) | null>;
 
     /**
      * 1h step of forecast
@@ -495,31 +484,16 @@ export interface DataSpecifications {
      */
     capDisplay: DataSpecificationsObject<'all' | 'today' | 'tomm' | 'later'>;
 
-    /**
-     * Range of displayed radar history
-     */
-    radarRange: DataSpecificationsObject<'archive' | 'long' | 'medium' | 'short'>;
-
     /**
      * Timestamp in ms
      */
     radarTimestamp: DataSpecificationsObject<Timestamp>;
 
-    /**
-     * Animation speed
-     */
-    radarSpeed: DataSpecificationsObject<'slow' | 'medium' | 'fast'>;
-
     /**
      * Radar calendar
      */
     radarCalendar: DataSpecificationsObject<RadarCalendar | null>;
 
-    /**
-     * Animation is running
-     */
-    radarAnimation: DataSpecificationsObject<boolean>;
-
     /**
      * Visible lightning data on radar
      */
@@ -530,11 +504,6 @@ export interface DataSpecifications {
      */
     blitzSoundOn: DataSpecificationsObject<boolean>;
 
-    /**
-     * Range of displayed satellite history
-     */
-    satelliteRange: DataSpecificationsObject<'archive' | 'long' | 'medium' | 'short'>;
-
     /**
      * Timestamp in ms
      */
@@ -546,19 +515,9 @@ export interface DataSpecifications {
     satelliteCalendar: DataSpecificationsObject<SatelliteCalendar | null>;
 
     /**
-     * Satellite animation is running
-     */
-    satelliteAnimation: DataSpecificationsObject<boolean>;
-
-    /**
-     * Satellite visualization modes
+     * Interpolate images using vectors
      */
-    satelliteMode: DataSpecificationsObject<'BLUE' | 'VISIR' | 'IRBT' | 'DBG'>; // 'IR',
-
-    /**
-     * Animation speed
-     */
-    satelliteSpeed: DataSpecificationsObject<'slow' | 'medium' | 'fast'>;
+    radSatFlowOn: DataSpecificationsObject<boolean>;
 
     /**
      * Extrapolate satellite images to future
@@ -687,14 +646,6 @@ export interface DataSpecifications {
      */
     notifications: DataSpecificationsObject<NotificationPreferences | null>;
 
-    /**
-     * User likes to receive ad hoc pushNotification
-     * For instance METAR update.
-     * Once set, it always stays on on this device
-     * @ignore
-     */
-    adHocNotification: DataSpecificationsObject<boolean>;
-
     /**
      * Number of unread notifications
      * @ignore
@@ -729,11 +680,6 @@ export interface DataSpecifications {
      */
     authHash: DataSpecificationsObject<string | null>;
 
-    /**
-     * Globe plugin is active (used for disabling isolines in overlays plugin)
-     */
-    globeActive: DataSpecificationsObject<boolean>;
-
     /**
      * Webcam or station last location (used for globe picker initial location)
      * @ignore
@@ -757,12 +703,6 @@ export interface DataSpecifications {
      */
     launchedBy: DataSpecificationsObject<'radar-widget' | null>;
 
-    /**
-     * Any stored color
-     * @ignore
-     */
-    [key: `color2_${string}`]: DataSpecificationsObject<ColorGradient | null>;
-
     /**
      * Any stored metric
      * @ignore
@@ -836,35 +776,15 @@ export interface DataSpecifications {
      */
     pickerMobileTimeout: DataSpecificationsObject<PickerMobileTimeout>;
 
-    /**
-     * Selected area and layers for offline mode
-     * @ignore
-     */
-    offlineSetting: DataSpecificationsObject<OfflineConfiguration | null>;
-
     /**
      * Endable/dissable change of detail location, when map is dragged
      */
     changeDetailOnMapDrag: DataSpecificationsObject<boolean>;
 
     /**
-     * Simple, easy to use indicator, if we are running in offline mode
-     * @ignore
-     */
-    offlineMode: DataSpecificationsObject<boolean>;
-
-    /**
-     * Imfo about offline data residing in serviceWorker
-     * @ignore
-     */
-    offlineDataInfo: DataSpecificationsObject<DownloadedInfo | null>;
-
-    /**
-     * Enables/disables offline mode at all. If false, offline mode is not available
-     * and serviceWorker is not installed at all
-     * @ignore
+     * Timestamp in ms
      */
-    offlineModeEnabled: DataSpecificationsObject<boolean>;
+    radsatTimestamp: DataSpecificationsObject<Timestamp>;
 
     /**
      * Display this type of WX stations on POI map
@@ -888,11 +808,17 @@ export interface DataSpecifications {
     stationCompareHiddenProducts: DataSpecificationsObject<PointProducts[]>;
 
     /**
-     * Main GSPR, privacy or cookie consent object
+     * Main GDPR, privacy or cookie consent object
      * @ignore
      */
     consent: DataSpecificationsObject<Consent | null>;
 
+    /**
+     * Is analytics consent required
+     * @ignore
+     */
+    analyticsConsentRequired: DataSpecificationsObject<boolean | null>;
+
     /**
      * Youtube cookie consent object
      * @ignore
@@ -920,6 +846,39 @@ export interface DataSpecifications {
      * User has entered into arrange mode in RH menu
      */
     rhMenuArrangeMode: DataSpecificationsObject<boolean>;
+
+    /*
+     * If startup widgets should persist
+     */
+    persistentWidgets: DataSpecificationsObject<boolean>;
+
+    /**
+     * List of interests user has, based on onboarding picker
+     */
+    userInterests: DataSpecificationsObject<UserInterest[]>;
+
+    onboardingFinished: DataSpecificationsObject<boolean>;
+
+    locationPermissionsGranted: DataSpecificationsObject<boolean>;
+
+    doNotShowLocationPermissionsPopup: DataSpecificationsObject<boolean>;
+
+    locationPermissionsPopupShown: DataSpecificationsObject<number | null>;
+
+    loginAndFinishAction: DataSpecificationsObject<
+        (LoginAndFinishAction & { updated: Timestamp }) | null
+    >;
+
+    /**
+     * If user wants to display just some type of favs in favs plugin
+     */
+    favsFilter: DataSpecificationsObject<FavTypeNew[]>;
+
+    /**
+     * Contains information, that registration hash for pushNotifications has been
+     * successfully sent to the backend
+     */
+    pushNotificationsReady: DataSpecificationsObject<boolean>;
 }
 
 /**

package/types/client/d.ts.files/favs.d.ts

@@ -0,0 +1,69 @@
+import type { RouteType, StationId, Timestamp } from '@windy/types';
+import type { LatLon, Alert, AlertProps } from '@windy/interfaces';
+
+export type FavId = string;
+
+/** New fav type not including alerts */
+export type FavTypeNew = 'fav' | 'airport' | 'station' | 'webcam' | 'route';
+
+/** @deprecated Old fav type including alert that will be abandoned soon */
+export type FavType = FavTypeNew | 'alert';
+
+export type RouteAsString = `${RouteType}/${string}`;
+
+export type FavFragment =
+    | (LatLon & {
+          /** Title of the fav */
+          title: string;
+      }) &
+          (
+              | { type: 'fav' }
+
+              /** @deprecated use till migration of alerts is in process */
+              | {
+                    type: 'alert';
+                    alert: Alert;
+                    alertProps: AlertProps;
+                }
+
+              /** Airport ICAO code in case of airport */
+              | { type: 'airport'; icao: string }
+
+              /** Weather station ID (if WX station) */
+              | { type: 'station'; stationId: StationId }
+              | { type: 'webcam'; webcamId: number }
+              | { type: 'route'; route: RouteAsString }
+          );
+
+export type Fav = FavFragment & {
+    /** Unique mongoDb ID of item */
+    id: FavId;
+
+    /**
+     * If user wants to pin to top this fav, this timestamp enable us to sort all the favs
+     * so the last pinned is on top
+     */
+    pin2top?: Timestamp | null;
+
+    /**
+     * If user wants to pin to homepage this fav, this timestamp enable us to sort all the favs
+     * so the last pinned is first in line
+     */
+    pin2homepage?: Timestamp | null;
+
+    /**
+     * Timestamp when the item has been updated for the last time. It is used for updating items on all devices (the most up-to-date wins)
+     */
+    updated: Timestamp;
+};
+
+export type ObsoleteFav = FavFragment & {
+    key: string;
+};
+
+export type FavQuery =
+    | { webcamsId: number }
+    | { stationId: StationId }
+    | { icao: string }
+    | { type: FavType }
+    | { title: string };

package/types/client/d.ts.files/incomingMessages.d.ts

@@ -53,10 +53,6 @@ export interface QueryStringEmbedParams {
     product?: Products;
     showDetail: boolean;
     showMarker: boolean;
-    /**
-     * @deprecated Only used for query string of type=alert
-     */
-    timestamps?: string;
     type: 'map' | 'alert' | 'forecast';
     zoom: number;
 }

package/types/client/d.ts.files/notifications.d.ts

@@ -1,8 +1,8 @@
 import { QueryStringSource } from '@windy/http.d';
 
 export interface NotifHttpQsOptions extends QueryStringSource {
-    pageSize: number;
-    current: number;
+    pageSize?: number;
+    current?: number;
     markAsViewed?: boolean;
 }