@windycom/plugin-devtools 2.0.0 → 3.0.1

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

@@ -1,5 +1,4 @@
 import {
-    AcTimes,
     GlobalPointProducts,
     Isolines,
     Levels,
@@ -13,9 +12,9 @@ import {
 
 import {
     Consent,
+    DetailExtendedLatLon,
     GeolocationInfo,
     HomeLocation,
-    InstalledExternalPluginConfig,
     LatLon,
 } from '@windy/interfaces.d';
 
@@ -26,17 +25,21 @@ import {
     ShowableError,
     SubTier,
     Timestamp,
-    type RouteMotionSpeed,
+    Hours,
+    RouteMotionSpeed,
+    UsedMapLibrary,
+    UserInterest,
 } from '@windy/types.d';
 
-import { ColorGradient } from '@windy/Color.d';
-
 import { MetricItem } from '@windy/Metric.d';
 
+import type { LoginAndFinishAction, User } 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 '@windy/alerts.d';
+import type { FavTypeNew } from '@windy/favs.d';
 
 /**
  * Custom animation particles settings
@@ -54,6 +57,9 @@ export interface CustomParticles {
  */
 export interface NotificationPreferences {
     email?: string;
+    preferredNotificationTime?: NumberRange[];
+    frequencyDays?: number;
+    usedTimezoneName?: string;
     sendToEmail: boolean;
     sendToMobile: boolean;
 }
@@ -77,21 +83,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 +141,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)
      */
@@ -167,6 +152,11 @@ export interface DataSpecificationsObject<T> {
     asyncSet?: (...args: unknown[]) => Promise<T>;
 }
 
+export interface FeatureFlags {
+    disableSatellitePlus: boolean;
+    disableNewRadarPlusGui: boolean;
+}
+
 /**
  * # Properties used in @windy/store
  *
@@ -176,7 +166,6 @@ export interface DataSpecificationsObject<T> {
  *  `overlay`,
  *  `level`,
  *  `availLevels`,
- *  `acTime`,
  *  `timestamp`,
  *  `isolines`,
  *  `product`,
@@ -206,9 +195,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
@@ -226,12 +215,17 @@ export interface DataSpecifications {
      * Read only value! UTC string containing time of actually rendered data that are available for current overlay and weather model.
      * @ignore
      */
-    path: DataSpecificationsObject<Path>;
+    path: DataSpecificationsObject<Path | null>;
 
     /**
-     * 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
+     */
+    isolinesType: DataSpecificationsObject<Isolines>;
+
+    /**
+     * Whether to render isolines
      */
-    isolines: DataSpecificationsObject<Isolines>;
+    isolinesOn: DataSpecificationsObject<boolean>;
 
     /**
      * Product is set of weather data, that have same resolution, boundaries, time range and so on.
@@ -250,11 +244,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
@@ -298,6 +287,11 @@ export interface DataSpecifications {
      */
     latlon: DataSpecificationsObject<boolean>;
 
+    /**
+     * Display altitude on picker
+     */
+    showPickerElevation: DataSpecificationsObject<boolean>;
+
     /**
      * Desired language for Windy. By default is determined by user's browser setting and set to `auto`.
      * Use `store.getAllowed('lang')` to get list of avail langs defined in `supportedLanguages.
@@ -309,6 +303,11 @@ export interface DataSpecifications {
      */
     englishLabels: DataSpecificationsObject<boolean>;
 
+    /**
+     * Consent to receive newsletter
+     */
+    marketingConsent: DataSpecificationsObject<boolean>;
+
     /**
      * Display directions in Weather picker as number or as a string (for example NW).
      */
@@ -330,15 +329,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 +360,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
      */
@@ -389,6 +400,11 @@ export interface DataSpecifications {
      */
     startUpLastOverlay: DataSpecificationsObject<boolean>;
 
+    /**
+     * User selected default zoom
+     */
+    startUpZoom: DataSpecificationsObject<number | null>;
+
     /**
      * Save forecast resolution step to be used at startup.
      * 1: 1h step
@@ -411,11 +427,6 @@ export interface DataSpecifications {
      */
     startupReverseName: DataSpecificationsObject<ReverseResult | null>;
 
-    /**
-     * NOTAMs marked as read
-     */
-    notams: DataSpecificationsObject<Record<string, number> | null>;
-
     /**
      * Users email
      */
@@ -431,6 +442,11 @@ export interface DataSpecifications {
      */
     displayHeliports: DataSpecificationsObject<boolean>;
 
+    /**
+     * Display Airspaces map layer in the METARs POI layer
+     */
+    displayAirspaces: DataSpecificationsObject<boolean>;
+
     /**
      * User statistics
      * @ignore
@@ -449,17 +465,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<DetailExtendedLatLon | null>;
 
     /**
      * 1h step of forecast
@@ -495,31 +505,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 +525,6 @@ export interface DataSpecifications {
      */
     blitzSoundOn: DataSpecificationsObject<boolean>;
 
-    /**
-     * Range of displayed satellite history
-     */
-    satelliteRange: DataSpecificationsObject<'archive' | 'long' | 'medium' | 'short'>;
-
     /**
      * Timestamp in ms
      */
@@ -546,19 +536,9 @@ export interface DataSpecifications {
     satelliteCalendar: DataSpecificationsObject<SatelliteCalendar | null>;
 
     /**
-     * Satellite animation is running
-     */
-    satelliteAnimation: DataSpecificationsObject<boolean>;
-
-    /**
-     * Satellite visualization modes
-     */
-    satelliteMode: DataSpecificationsObject<'BLUE' | 'VISIR' | 'IRBT' | 'DBG'>; // 'IR',
-
-    /**
-     * Animation speed
+     * Interpolate images using vectors
      */
-    satelliteSpeed: DataSpecificationsObject<'slow' | 'medium' | 'fast'>;
+    radSatFlowOn: DataSpecificationsObject<boolean>;
 
     /**
      * Extrapolate satellite images to future
@@ -687,14 +667,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 +701,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
@@ -751,18 +718,6 @@ export interface DataSpecifications {
      */
     mapCoords: DataSpecificationsObject<MapCoordinates | null>;
 
-    /**
-     * Whether app has been launched from some source which requires different init state
-     * @ignore
-     */
-    launchedBy: DataSpecificationsObject<'radar-widget' | null>;
-
-    /**
-     * Any stored color
-     * @ignore
-     */
-    [key: `color2_${string}`]: DataSpecificationsObject<ColorGradient | null>;
-
     /**
      * Any stored metric
      * @ignore
@@ -836,35 +791,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 +823,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
@@ -910,16 +851,59 @@ export interface DataSpecifications {
      */
     appLocalStorageCounter: DataSpecificationsObject<number | null>;
 
-    /**
-     * List of installed external plugins
-     * @ignore
-     */
-    installedPlugins: DataSpecificationsObject<InstalledExternalPluginConfig[]>;
-
     /*
      * 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>;
+
+    /**
+     * Feature flags to enable/disable features without the need to re-release the client
+     */
+    featureFlags: DataSpecificationsObject<FeatureFlags>;
+
+    /**
+     * Whenever fullscreen plugin is opened on mobile device suspend potential
+     * sound & haptic feedback on radar/sat layers
+     */
+    suspendSoundAndHaptic: DataSpecificationsObject<boolean>;
+
+    /**
+     * User has enabled advanced features in debug console
+     */
+    advancedDebugConsole: DataSpecificationsObject<boolean>;
 }
 
 /**

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

@@ -0,0 +1,68 @@
+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/lib.d.ts

@@ -41,12 +41,11 @@ export interface InitOptions extends WindyAPIOptions {
     zoom?: number;
 }
 
-type ApiPicker =
-    | typeof import('@windy/picker') & {
-          open: (latLon: LatLon) => void;
-          close: () => void;
-          getParams: () => PluginsOpenParams['picker'];
-      };
+type ApiPicker = typeof import('@windy/picker') & {
+    open: (latLon: LatLon) => void;
+    close: () => void;
+    getParams: () => PluginsOpenParams['picker'];
+};
 
 export type InitCb = (windyAPI: {
     map: WModules['map']['map'];
@@ -61,7 +60,6 @@ export type InitCb = (windyAPI: {
 export interface ApiAuthResponse {
     domains: string;
     paid: boolean;
-    apiUser: string;
     id: string;
     name: string;
     type: string;

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;
 }