@windycom/plugin-devtools 3.0.1 → 3.0.3

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

@@ -4,27 +4,30 @@
 
     Now it is better to use close coupled components, with strong type control
 
-
     TODO: Minimize amount of these events and reduce their usage
 
 */
-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 { Evented } from '@windy/Evented';
 import { MetricIdent, MetricItem } from '@windy/Metric.d';
 import { PluginIdent } from '@windy/Plugin';
 import { NotificationPreferences } from '@windy/dataSpecifications.d';
-import { GeolocationInfo, LatLon, WeatherParameters } from '@windy/interfaces.d';
+import {
+    GeolocationInfo,
+    LatLon,
+    WeatherParameters,
+    type FullRenderParameters,
+} 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 { ZoomOptions } from '@leafletGl';
 import type { RadarPlusLayer } from '@plugins/radar-plus/types';
-import type { ParsedStartupValues } from './router';
+import type { ParsedStartupValues } from '@windy/router';
+import type { ParsLocation as GlobeParsLocation } from '@plugins/globe/main/receiver.d';
+import type { Params as GlobeParams, Poi as GlobePoi } from '@plugins/globe/types.d';
+import type { ExtendedDataAndParams } from '@plugins/isolines/IsolinesCanvas2D.d';
 
 type BcastTypesNonGeneric = {
     /**
@@ -97,21 +100,25 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
      * Do not not use this event to start any intensive action since Windy now
      * must load and render all the data. We recommend to use `redrawFinished` instead.
      */
-    paramsChanged: [WeatherParameters, keyof WeatherParameters | undefined];
+    paramsChanged: [WeatherParameters, keyof WeatherParameters | 'path' | undefined];
 
     /**
      * Indicates that user changed any of the units (wind, temp, ...).
      */
     metricChanged: [MetricIdent | undefined, MetricItem | undefined];
 
-    /** Indicates that user added, remover or rename his fav  */
+    /** Indicates that user added, removed or rename his fav  */
     favChanged: [];
 
-    /** Indicates that user added, remover or rename his alert  */
+    /** Indicates that user added, removed or rename his alert  */
     alertChanged: [];
 
+    /** Indicates that user added or removed external plugin */
+    externalPluginChanged: [];
+
     /**
-     * Indicates, that router has parsed URL
+     * Indicates that router has parsed new route,
+     * used to trigger opening plugins based on url
      */
     routerParsed: [PluginIdent | ExternalPluginIdent | void, ParsedStartupValues | undefined];
 
@@ -137,32 +144,17 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     /** @ignore */ 'globe-zoomOut': [[number, number] | null] | [];
     /** @ignore */ 'globe-paramsChanged': [GlobeParams];
 
-    /** @ignore */ 'leaflet-zoomIn': [number | undefined, L.ZoomOptions | undefined];
-    /** @ignore */ 'leaflet-zoomOut': [number | undefined, L.ZoomOptions | undefined];
-    /** @ignore */ 'leaflet-paramsChanged': [
+    /** @ignore */ 'leafletGl-zoomIn': [number | undefined, ZoomOptions | undefined];
+    /** @ignore */ 'leafletGl-zoomOut': [number | undefined, ZoomOptions | undefined];
+    /** @ignore */ 'leafletGl-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 embed, imaker indicates that detail is ready
-    /** @ignore */ stationRendered: []; // used only in embed, imaker indicates that detail is ready
+    /** @ignore */ detailRendered: []; // used only in embed indicates that detail is ready
+    /** @ignore */ stationRendered: []; // used only in embed indicates that detail is ready
     /** @ignore */ reloadFavs: [];
     /** @ignore */ notifPrefChanged: [NotificationPreferences | undefined];
     /** @ignore */ satBackupReload: [];
@@ -175,11 +167,15 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     /** @ignore */ loadingFailed: [string];
     /** @ignore */ zoomIn: [];
     /** @ignore */ zoomOut: [];
-    /** @ignore */ userReloadInfo: [];
     /** @ignore */ showSocialError: [string];
-    /** @ignore */ openCapAlerts: [PluginsOpenParams['picker']];
     /** @ignore */ openapp: [];
     /** @ignore */ openSearch: [];
+    /** @ignore */ renderersUpdated: []; // Fired once all renderers have had their params updated.
+    /** @ignore */ tileLayerParamsChanged: [FullRenderParameters];
+    /** @ignore */ glContextLost: [];
+    /** @ignore */ glContextRestored: [];
+    /** @ignore */ glRestoreContext: [];
+    /** @ignore */ glLoseContext: [];
 }
 
 interface BcastTypes<T extends keyof Plugins> extends BcastTypesNonGeneric, BasicBcastTypes<T> {}

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

@@ -20,7 +20,6 @@ import {
 
 import {
     MenuItems,
-    Path,
     PickerMobileTimeout,
     ShowableError,
     SubTier,
@@ -29,17 +28,21 @@ import {
     RouteMotionSpeed,
     UsedMapLibrary,
     UserInterest,
+    type ISOCountryCode,
+    type AnimationSpeed,
 } from '@windy/types.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 RadarCalendar from '@plugins/radar/calendar/RadarCalendar';
-import type SatelliteCalendar from '@plugins/satellite/calendar/SatelliteCalendar';
+import type { SubscriptionInfo } from '@plugins/shared/subscription-services/subscription-services.d';
+import type RadarCalendar from '@plugins/radar-plus/calendar/radarCalendar';
+import type { SatelliteCalendar } from '@plugins/radar-plus/calendar/satelliteCalendar';
 import type { NumberRange } from '@windy/alerts.d';
-import type { FavTypeNew } from '@windy/favs.d';
+import type { FavType } from '@windy/favs.d';
+import type { Range } from '@plugins/shared/radsat/context';
+import type { TiledPoiClasses } from '@plugins/poi-libs/poi-libs.d';
 
 /**
  * Custom animation particles settings
@@ -73,6 +76,7 @@ export interface ReverseResult extends LatLon {
     lang: string;
     region?: string;
     country?: string;
+    cc?: ISOCountryCode;
     name: string;
     nameValid?: boolean;
 }
@@ -103,7 +107,7 @@ export interface DataSpecificationsObject<T> {
     allowed: Readonly<T[]> | ((d: T) => boolean);
 
     /**
-     * Peristent item. Save this item to localStorage
+     * Persistent item. Save this item to localStorage
      */
     save?: boolean;
 
@@ -150,11 +154,22 @@ export interface DataSpecificationsObject<T> {
      * Setter function - asynchronous (will be run before value is set)
      */
     asyncSet?: (...args: unknown[]) => Promise<T>;
+
+    /**
+     * This item can be set only by syncSet or asyncSet (so basically it is derived store)
+     * This so far does not do anything, it's merely a flag for developer
+     */
+    readOnly?: boolean;
+
+    /**
+     * This item can be used by Premium only users. Free users get always default value,
+     * so additional checks before using store.get('item') are not necessary.
+     */
+    premiumOnly?: boolean;
 }
 
 export interface FeatureFlags {
-    disableSatellitePlus: boolean;
-    disableNewRadarPlusGui: boolean;
+    useNewGui: boolean;
 }
 
 /**
@@ -211,12 +226,6 @@ export interface DataSpecifications {
      */
     timestamp: DataSpecificationsObject<Timestamp>;
 
-    /**
-     * Read only value! UTC string containing time of actually rendered data that are available for current overlay and weather model.
-     * @ignore
-     */
-    path: DataSpecificationsObject<Path | null>;
-
     /**
      * Which type of isolines to render
      */
@@ -257,6 +266,11 @@ export interface DataSpecifications {
      */
     animation: DataSpecificationsObject<boolean>;
 
+    /**
+     * Animation playback speed (normal = legacy speed)
+     */
+    animationSpeed: DataSpecificationsObject<AnimationSpeed>;
+
     /**
      * Actual calendar (instance of `Calendar`) for selected overlay/product (if it has calendar)
      */
@@ -272,11 +286,6 @@ export interface DataSpecifications {
      */
     particlesAnim: DataSpecificationsObject<'on' | 'off' | 'intensive'>;
 
-    /**
-     * Last modified timestamp of just rendered data (read only)
-     */
-    lastModified: DataSpecificationsObject<Timestamp>;
-
     /**
      * Display graticule over the map
      */
@@ -292,6 +301,11 @@ export interface DataSpecifications {
      */
     showPickerElevation: DataSpecificationsObject<boolean>;
 
+    /**
+     * Whether picker is being dragged
+     */
+    pickerDragging: 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.
@@ -321,12 +335,12 @@ export interface DataSpecifications {
     /**
      * 2 letter lowercase Country Code
      */
-    country: DataSpecificationsObject<string>;
+    country: DataSpecificationsObject<ISOCountryCode | 'xx'>;
 
     /**
-     * Is imperial as default settings (computed property)
+     * Default units setting (computed on the first visit based on GeoIP)
      */
-    isImperial: DataSpecificationsObject<boolean>;
+    defaultUnits: DataSpecificationsObject<'unset' | 'imperial' | 'metric'>;
 
     /**
      * Type of map tiles map shown in detail
@@ -345,16 +359,6 @@ export interface DataSpecifications {
 
     stormSettingsLightning: DataSpecificationsObject<boolean>;
 
-    /**
-     * Is WebGL disabled?
-     */
-    disableWebGL: DataSpecificationsObject<boolean>;
-
-    /**
-     * Indicates whether glParticles are on or off
-     */
-    glParticlesOn: DataSpecificationsObject<boolean>;
-
     /**
      * Finally used language (the one which is successfully loaded in trans module)
      */
@@ -476,11 +480,6 @@ export interface DataSpecifications {
      */
     detail1h: DataSpecificationsObject<boolean>;
 
-    /**
-     * Timestamp of detail's progress bar or middleFrame
-     */
-    detailTimestamp: DataSpecificationsObject<Timestamp>;
-
     /**
      * Detail keeps its 10+ days expanded forecast
      */
@@ -496,12 +495,8 @@ export interface DataSpecifications {
      */
     camsPreviews: DataSpecificationsObject<boolean>;
 
-    //
-    // CAP alerts
-    //
-
     /**
-     * Today, tomm, later
+     * Today, tomorrow, later
      */
     capDisplay: DataSpecificationsObject<'all' | 'today' | 'tomm' | 'later'>;
 
@@ -525,6 +520,11 @@ export interface DataSpecifications {
      */
     blitzSoundOn: DataSpecificationsObject<boolean>;
 
+    /**
+     * Whether to render baseLayer using tiles with thick borders
+     */
+    showThickBorders: DataSpecificationsObject<boolean>;
+
     /**
      * Timestamp in ms
      */
@@ -541,14 +541,9 @@ export interface DataSpecifications {
     radSatFlowOn: DataSpecificationsObject<boolean>;
 
     /**
-     * Extrapolate satellite images to future
-     */
-    satelliteExtraOn: DataSpecificationsObject<boolean>;
-
-    /**
-     * this override is needed for video capture
+     * Render precipitation type pattern on radar
      */
-    satelliteInterpolationOverride: DataSpecificationsObject<boolean>;
+    radarRenderPType: DataSpecificationsObject<boolean>;
 
     /**
      * Satellite/Radar archive on
@@ -565,11 +560,6 @@ export interface DataSpecifications {
      */
     archiveRange: DataSpecificationsObject<number>;
 
-    /**
-     * Information, if startup weather box is shown or not
-     */
-    startupWeatherShown: DataSpecificationsObject<boolean>;
-
     /**
      * pois layer that user selected
      *
@@ -624,7 +614,7 @@ export interface DataSpecifications {
     zuluMode: DataSpecificationsObject<boolean>;
 
     /**
-     * Sorting of nearest weater stations
+     * Sorting of nearest weather stations
      * @ignore
      */
     stationsSort: DataSpecificationsObject<'profi' | 'distance'>;
@@ -708,7 +698,8 @@ export interface DataSpecifications {
     lastPoiLocation: DataSpecificationsObject<(LatLon & { type?: string }) | null>;
 
     /**
-     * Picker last location
+     * Picker last location, to be consumed by location service to enhance URL
+     * Used only on desktop device
      */
     pickerLocation: DataSpecificationsObject<LatLon | null>;
 
@@ -792,7 +783,7 @@ export interface DataSpecifications {
     pickerMobileTimeout: DataSpecificationsObject<PickerMobileTimeout>;
 
     /**
-     * Endable/dissable change of detail location, when map is dragged
+     * Enable/disable change of detail location, when map is dragged
      */
     changeDetailOnMapDrag: DataSpecificationsObject<boolean>;
 
@@ -856,11 +847,6 @@ export interface DataSpecifications {
      */
     rhMenuArrangeMode: DataSpecificationsObject<boolean>;
 
-    /*
-     * If startup widgets should persist
-     */
-    persistentWidgets: DataSpecificationsObject<boolean>;
-
     /**
      * List of interests user has, based on onboarding picker
      */
@@ -881,7 +867,7 @@ export interface DataSpecifications {
     /**
      * If user wants to display just some type of favs in favs plugin
      */
-    favsFilter: DataSpecificationsObject<FavTypeNew[]>;
+    favsFilter: DataSpecificationsObject<FavType[]>;
 
     /**
      * Contains information, that registration hash for pushNotifications has been
@@ -889,7 +875,7 @@ export interface DataSpecifications {
      */
     pushNotificationsReady: DataSpecificationsObject<boolean>;
 
-    /**
+    /*
      * Feature flags to enable/disable features without the need to re-release the client
      */
     featureFlags: DataSpecificationsObject<FeatureFlags>;
@@ -904,6 +890,36 @@ export interface DataSpecifications {
      * User has enabled advanced features in debug console
      */
     advancedDebugConsole: DataSpecificationsObject<boolean>;
+
+    /**
+     * Active tab in pin menu (fav-layers plugin)
+     */
+    pinMenuActiveTab: DataSpecificationsObject<'models' | 'layers'>;
+
+    /*
+     * Range of the currently used segment
+     */
+    radarPlusSegmentRange: DataSpecificationsObject<Range>;
+
+    /**
+     * Whether the debug performance overlay (frametimes & FPS) is enabled (DEBUG type setting)
+     */
+    perfOverlayEnabled: DataSpecificationsObject<boolean>;
+
+    /*
+     * Instance of TIlePoi, that is used to display POIs
+     */
+    tiledPoiLayer: DataSpecificationsObject<TiledPoiClasses | null>;
+
+    /**
+     * Whether to multisample pType composite when rendering pType (to smooth-out transition between precipitation categories)
+     */
+    pTypeMultiSampled: DataSpecificationsObject<boolean>;
+
+    /**
+     * Whether to DEBUG airport related stuff
+     */
+    airportDebugMode: DataSpecificationsObject<boolean>;
 }
 
 /**
@@ -924,7 +940,7 @@ export type PickDataSpecificationPropsByType<U, Strict = true> = Pick<
                     : never
                 : never
             : U extends DataSpecifications[P]['def']
-            ? P
-            : never;
+              ? P
+              : never;
     }[keyof DataSpecifications]
 >;

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

@@ -1,32 +1,25 @@
-import type { RouteType, StationId, Timestamp } from '@windy/types';
-import type { LatLon, Alert, AlertProps } from '@windy/interfaces';
+import type { ISOCountryCode, RouteType, StationId, Timestamp } from '@windy/types';
+import type { LatLon } 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 FavType = 'fav' | 'airport' | 'station' | 'webcam' | 'route';
 
 export type RouteAsString = `${RouteType}/${string}`;
 
 export type FavFragment = (LatLon & {
     /** Title of the fav */
     title: string;
+
+    /** Lowercase ISO 2 letter CC or xx if fav is in the ocean for example */
+    cc?: ISOCountryCode | 'xx';
 }) &
     (
         | { 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 }
+        | { type: 'airport'; icao: string; iata?: string }
 
         /** Weather station ID (if WX station) */
         | { type: 'station'; stationId: StationId }
@@ -56,10 +49,6 @@ export type Fav = FavFragment & {
     updated: Timestamp;
 };
 
-export type ObsoleteFav = FavFragment & {
-    key: string;
-};
-
 export type FavQuery =
     | { webcamsId: number }
     | { stationId: StationId }

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

@@ -0,0 +1,71 @@
+import type { Vector2, Vector3, Vector4 } from '@windy/math';
+import type { GlTexture } from '@windy/GlTexture';
+import type { GlslDataType } from '@windy/glUtils';
+
+export interface UniformRecord {
+    uniformId: string; // uniform identifier inside fragment shader
+    uniformLocation: WebGLUniformLocation | null; // bound uniform location
+    glDataType: GlslDataType;
+    value: UniformDataType;
+}
+
+/**
+ * Combined type of all possible numeric typed arrays in javascript
+ */
+export type TypedArray =
+    | Uint8Array
+    | Uint8ClampedArray
+    | Uint16Array
+    | Uint32Array
+    | Int8Array
+    | Int16Array
+    | Int32Array
+    | Float32Array
+    | Float64Array;
+
+export type UniformDataType =
+    | Float32List
+    | Vector4
+    | Vector3
+    | Vector2
+    | GlTexture
+    | WebGLTexture
+    | number
+    | undefined
+    | null;
+
+export type Gl2ColorFormat = WebGL2RenderingContextBase['RG8'] | WebGL2RenderingContextBase['R8'];
+
+export type GlColorFormat =
+    | WebGLRenderingContextBase['ALPHA']
+    | WebGLRenderingContextBase['RGB']
+    | WebGLRenderingContextBase['RGBA']
+    | WebGLRenderingContextBase['LUMINANCE']
+    | WebGLRenderingContextBase['LUMINANCE_ALPHA']
+    | Gl2ColorFormat;
+
+// https://developer.mozilla.org/en-US/docs/Web/API/EXT_disjoint_timer_query
+interface TimerQueryBase {
+    QUERY_COUNTER_BITS_EXT: GLenum;
+    CURRENT_QUERY_EXT: GLenum;
+    QUERY_RESULT_EXT: GLenum; // GLuint64EXT
+    QUERY_RESULT_AVAILABLE_EXT: GLenum;
+    TIME_ELAPSED_EXT: GLenum;
+    TIMESTAMP_EXT: GLenum;
+    GPU_DISJOINT_EXT: GLenum;
+    createQueryEXT: () => WebGLQuery;
+    deleteQueryEXT: (query: WebGLQuery) => void;
+    isQueryEXT: (query: WebGLQuery) => GLboolean;
+    beginQueryEXT: (target: GLenum, query: WebGLQuery) => void;
+    endQueryEXT: (target: GLenum) => void;
+    queryCounterEXT: (target: GLenum, query: WebGLQuery) => void;
+    getQueryEXT: (target: GLenum, pname: GLenum) => WebGLQuery | GLint;
+}
+
+export interface EXT_disjoint_timer_query extends TimerQueryBase {
+    getQueryObjectEXT: (query: WebGLQuery, pname: GLenum) => GLuint64 | GLboolean;
+}
+
+export interface EXT_disjoint_timer_query_webgl2 extends TimerQueryBase {
+    getQueryParameter: (query: WebGLQuery, pname: GLenum) => GLuint64 | GLboolean;
+}

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

@@ -51,14 +51,14 @@ export interface HttpOptions {
     ttl?: Timestamp;
 
     /**
-     * Request timeout (in ms)
+     * Custom headers object
      */
-    timeout?: Timestamp;
+    customHeaders?: Record<string, string>;
 
     /**
-     * Custom headers object
+     * Use already prepared and ongoing fetch requests if available
      */
-    customHeaders?: Record<string, string>;
+    ongoingFetchRequest?: ReturnType<typeof fetch>;
 }
 
 /**

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

@@ -1,5 +1,5 @@
 import { NumValue } from '@windy/types.d';
-import { LatLon } from '@windy/interfaces.d';
+import { LatLon, type FullRenderParameters } from '@windy/interfaces.d';
 
 /**
  * Returned values in data RGB channels as tuple [NumValue, NumValue, NumValue]
@@ -23,13 +23,13 @@ export type InterpolatorPossibleReturns = RGBNumValues | null | undefined | numb
  * Interpolates pixel to tuple weather values from RGB channels
  */
 export type PixelInterpolationFun = (
-    x: number,
-    y: number,
     mercXpx?: number, // mercator coords in pixels (needed for radar and satellite)
     mercYpx?: number,
-) => InterpolatorPossibleReturns;
+    abort?: AbortController,
+    params?: FullRenderParameters
+) => Promise<InterpolatorPossibleReturns>;
 
 /**
  * Interpolates coordinates to tuple weather values from RGB channels
  */
-export type CoordsInterpolationFun = <T extends LatLon>(latLon: T) => InterpolatorPossibleReturns;
+export type CoordsInterpolationFun = <T extends LatLon>(latLon: T, abort?: AbortController, params?: FullRenderParameters) => Promise<InterpolatorPossibleReturns>;

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

@@ -15,12 +15,11 @@ type AllowedDataSpecifications = Pick<
     | 'particles'
     | 'numDirection'
     | 'lang'
-    | 'disableWebGL'
     | 'graticule'
     | 'particlesAnim'
     | 'timestamp'
     | 'isolines'
-    | 'isImperial'
+    | 'defaultUnits'
     | 'latlon'
     | 'hourFormat'
     | 'favOverlays'

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

@@ -0,0 +1,52 @@
+import type { Platform } from '@windy/types';
+
+// In the future, the settings may look like this
+// "services": {
+//     "storms": {
+//         "enabled": true,
+//         "trackCurrentLocation": true,
+//         "locations": [{ "lat": 1, "lon": 2 }]
+//     },
+//     "tornadoes": {
+//         "enabled": true,
+//         "minForce": "F5",
+//         "trackCurrentLocation": true,
+//     },
+//     "earthquakes": {
+//         "enabled": true,
+//         "minMagnitude": 5,
+//         "trackCurrentLocation": true,
+//         "locations": [{ "lat": 1, "lon": 2 }]
+//     }
+// }
+export interface LocationEntityServices {
+    storms: {
+        enabled: boolean;
+    };
+    rain: {
+        enabled: boolean;
+    };
+    // TODO Enable for all when supported by BE
+    // For some reason, BE uses unclear acronym instead of tropicalCyclones
+    tc?: {
+        enabled: boolean;
+    };
+    cap?: {
+        enabled: boolean;
+    };
+}
+
+export type DistanceUnit = 'km' | 'mi' | 'NM';
+
+export interface LocationEntity {
+    services: LocationEntityServices;
+    platform: Platform;
+    deviceToken: string;
+    language: string;
+    lat?: number;
+    locationEntityId?: string;
+    lon?: number;
+    units: {
+        distance: DistanceUnit;
+    };
+}