@windycom/plugin-devtools 2.0.0 → 3.0.1

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

@@ -1,5 +1,5 @@
 import { NumberedMetric, PrecipMetric, PtypeMetric, UVIndexMetric } from '@windy/MetricClasses';
-import { DataQuality, FileSuffix } from '@windy/Product.d';
+import { DataQuality, FileSuffix } from '@windy/Product';
 import { WeatherParameters } from '@windy/interfaces.d';
 import { Levels, Overlays } from '@windy/rootScope.d';
 import { NumValue, Path } from '@windy/types.d';
@@ -71,6 +71,7 @@ export interface LayerMetricType {
     dustsm: NumberedMetric;
     radar: NumberedMetric;
     satellite: NumberedMetric;
+    radarPlus: NumberedMetric;
     gtco3: NumberedMetric;
     pm2p5: NumberedMetric;
     no2: NumberedMetric;
@@ -91,6 +92,7 @@ export interface LayerMetricType {
     dfm10h: NumberedMetric;
     turbulence: NumberedMetric;
     icing: NumberedMetric;
+    topoMap: undefined;
 }
 
 /**
@@ -181,4 +183,9 @@ interface FullRenderParameters extends WeatherParameters, RenderParams {
     refTime: string;
     fullPath: string;
     path: Path;
+
+    /**
+     * Optional accumulation range in hours
+     */
+    acRangeInHours?: number;
 }

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

@@ -101,6 +101,7 @@ export interface MetricTypes {
     dust: NumberedMetric;
     cosc: NumberedMetric;
     radar: NumberedMetric;
+    radsat: SatelliteMetric;
     satellite: SatelliteMetric;
     ptype: PtypeMetric;
     gh: NumberedMetric;

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

@@ -1,16 +1,25 @@
 import { TransformFunction } from '@windy/Layer.d';
 import { TilePoint } from '@windy/interfaces.d';
 
+import type { BottomSveltePlugins, Plugins, SveltePlugins } from '@windy/plugins.d';
+
+export type AllowedRenderPlugins = Pick<
+    Plugins,
+    'radar' | 'satellite' | 'radar-plus' | 'cap-alerts' | 'isolines' | 'gl-particles' | 'particles'
+>;
+
 export type Renderers =
     | 'tileLayer'
     | 'radar'
     | 'satellite'
+    | 'radarPlus'
     | 'capAlerts'
     | 'isolines'
     | 'particles'
     | 'accumulations'
     | 'daySwitcher'
-    | 'noUserControl';
+    | 'noUserControl'
+    | 'topoMap';
 
 export interface TileParams extends TilePoint {
     url: string;
@@ -21,3 +30,15 @@ export interface TileParams extends TilePoint {
     transformG: TransformFunction | null;
     transformB: TransformFunction | null;
 }
+
+export type AllowedUserControls =
+    | keyof BottomSveltePlugins
+    | keyof SveltePlugins
+    | 'map-selector'
+    | 'none';
+
+export interface RendererInitParams {
+    ident: Renderers;
+    dependency?: keyof AllowedRenderPlugins;
+    userControl?: AllowedUserControls;
+}

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

@@ -0,0 +1,119 @@
+import {
+    AlertConditionType,
+    CloudCoverage,
+    AlertStatus,
+    Direction,
+    Weekday,
+} from '@windy/userAlerts';
+import type { Timestamp, UserInterest } from '@windy/types';
+import type { Products } from '@windy/rootScope.d';
+import type { LatLon } from '@windy/interfaces';
+
+export interface AlertRequest {
+    conditions: AlertCondition[];
+    description: string;
+    favToDeleteId?: string;
+    lat: number;
+    locationName: string;
+    lon: number;
+    model: GlobalProductWithWaves | null;
+    priority?: number;
+    suspended: boolean;
+    userInterest: UserInterest;
+    hasCustomDescription?: boolean;
+}
+
+export type GlobalProductWithWaves = Extends<Products, 'ecmwf' | 'gfs' | 'icon' | 'mblue'>;
+
+export interface AlertCheckResponse {
+    /**
+     * Array of timestamps when the trigger is triggered
+     */
+    timestamps: Timestamp[];
+}
+
+export interface NumberRange {
+    from: number;
+    to: number;
+}
+
+export interface AlertConditionBase {
+    type: AlertConditionType;
+}
+
+export interface CloudinessAlertCondition extends AlertConditionBase {
+    type: AlertConditionType.Cloudiness;
+    cloudCoverage: CloudCoverage[];
+}
+
+export interface FreshSnowAlertCondition extends AlertConditionBase {
+    rangeCentimeters: NumberRange;
+    type: AlertConditionType.FreshSnow;
+}
+
+export interface RainfallAlertCondition extends AlertConditionBase {
+    hours: number;
+    rangeMilliliters: NumberRange;
+    type: AlertConditionType.Rainfall;
+}
+
+export interface SwellAlertCondition extends AlertConditionBase {
+    directions: Direction[];
+    rangeSwellMeters: NumberRange;
+    type: AlertConditionType.Swell;
+}
+
+export interface TemperatureAlertCondition extends AlertConditionBase {
+    rangeKelvin: NumberRange;
+    type: AlertConditionType.Temperature;
+}
+
+export interface TimeAlertCondition extends AlertConditionBase {
+    /** Days of the week in which the conditions must be met */
+    days: Weekday[];
+    /** Hours of the day in which the conditions must be met */
+    hours?: NumberRange[];
+    /** Minimum duration of meeting the conditions to send the notification */
+    minDurationHours: number;
+    /** Range of days which will be checked for conditions */
+    rangeDays?: NumberRange;
+    type: AlertConditionType.Time;
+}
+
+export interface WindAlertCondition extends AlertConditionBase {
+    directions: Direction[];
+    rangeWindMetersPerSecond: NumberRange;
+    type: AlertConditionType.Wind;
+}
+
+export type AlertCondition =
+    | CloudinessAlertCondition
+    | FreshSnowAlertCondition
+    | RainfallAlertCondition
+    | SwellAlertCondition
+    | TemperatureAlertCondition
+    | TimeAlertCondition
+    | WindAlertCondition;
+
+/** MongoDb id of the alert */
+export type AlertId = string;
+
+export interface AlertResponse extends AlertRequest {
+    created: Timestamp;
+    updated: Timestamp;
+    id: AlertId;
+}
+
+/** Group with multiple alerts in it */
+export interface AlertGroupObject extends LatLon {
+    key: string;
+    locationName: string;
+    priority: number;
+    alerts: AlertResponse[];
+}
+
+/** Enhanced Alert */
+export interface EnhancedAlert extends AlertResponse {
+    status: AlertStatus;
+    timestamps: Timestamp[];
+}

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

@@ -8,20 +8,23 @@
     TODO: Minimize amount of these events and reduce their usage
 
 */
-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';
+import type { ParsedStartupValues } from './router';
 
 type BcastTypesNonGeneric = {
     /**
@@ -74,7 +77,7 @@ 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];
 
     /**
@@ -101,38 +104,70 @@ 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
+     * Indicates, that router has parsed URL
      */
-    routerParsed: [PluginIdent | ExternalPluginIdent | void];
+    routerParsed: [PluginIdent | ExternalPluginIdent | void, ParsedStartupValues | undefined];
+
+    /**
+     * Indicates that mobile ui of plugin using BottomSlide was half opened
+     */
+    pluginHalfOpened: [PluginIdent, boolean];
+
+    /**
+     * Request to half open plugin, used in BottomSlide
+     */
+    rqstHalfOpen: [ident: PluginIdent, value: boolean | undefined, emit: boolean | undefined];
 
     // prettier-ignore
     /** @ignore */ globeOpened: [];
     /** @ignore */ globeClose: [];
     /** @ignore */ globeFailed: [];
-    /** @ignore */ 'globe-detail': [DetailLocChangeParams | (LatLon & PluginSource)];
+
+    /** @ignore */ 'globe-detail': [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 */ detailRendered: []; // used only in embed, imaker indicates that detail is ready
+    /** @ignore */ stationRendered: []; // used only in embed, imaker indicates that detail is ready
     /** @ignore */ reloadFavs: [];
     /** @ignore */ notifPrefChanged: [NotificationPreferences | undefined];
     /** @ignore */ satBackupReload: [];
     /** @ignore */ promptSavePassword: [];
-    /** @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 +180,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> {}