@windycom/plugin-devtools 3.0.1 → 3.0.2

package/types/interfaces.d.ts

@@ -1,43 +1,49 @@
 /**
  * Main Windy interfaces
  */
-import { Weekday } from '@windy/Calendar.d';
+import { Weekday } from '@windy/Calendar';
 import { ExtendedTileParams } from '@windy/DataTiler.d';
 import { FavId } from '@windy/favs';
-import { FullRenderParameters } from '@windy/Layer.d';
+import { Layers } from '@windy/Layer';
 import { Particles } from '@windy/Particles';
-import { PluginsOpenParams, PluginOpenEventSource, PluginsQsParams } from '@windy/plugin-params.d';
+import { PluginOpenEventSource, PluginsOpenParams, PluginsQsParams } from '@windy/plugin-params.d';
 import { Plugins } from '@windy/plugins.d';
+import { DataQuality } from '@windy/Product';
 import { Isolines, Levels, Overlays, PointProducts, Products } from '@windy/rootScope.d';
 import {
     BatteryPreferences,
     CapAlertInfo,
     CapAlertSeverity,
     CapAlertType,
+    CustomAppIcon,
     DetailDisplayType,
     DetailRows,
     Directions,
     GoogleServicesPreferences,
     GpsPreferences,
+    Hours,
     ISODateString,
     LocationPreferences,
     MeteogramLayers,
     MeteogramLevels,
+    Minutes,
     NotificationPreferences,
     NumOrNull,
     NumValue,
+    ParticlesIdent,
     Path,
+    PatternType,
     Pixel,
     Platform,
+    RenderChannels,
+    SubTier,
     Timestamp,
+    TransformFunction,
     WidgetNotificationPreferences,
     WidgetType,
     YearMonthDay,
-    Hours,
-    Minutes,
-    SubTier,
-    CustomAppIcon,
 } from '@windy/types.d';
+import type { PaddingOptions, RequireAtLeastOne } from '@windycom/maplibre-gl';
 
 export interface ExportedObj {
     default?: unknown;
@@ -251,12 +257,11 @@ export interface AlertProps {
 }
 
 export interface WeatherParameters {
-    acRange: Timestamp;
+    acRange: Hours;
     overlay: Overlays;
     level: Levels;
     isolinesType: Isolines;
     isolinesOn: boolean;
-    path: Path;
     product: Products;
 }
 
@@ -488,7 +493,6 @@ export interface IsDay {
 /**
  * Weather data object as received from backend (full version)
  */
-
 export interface DataHash extends SummaryDataHash, IsDay {
     /**
      * Day identifier
@@ -508,7 +512,7 @@ export interface DataHash extends SummaryDataHash, IsDay {
     /**
      * Local Time hour for given place in 24h format
      */
-    hour: number[];
+    hour: Hours[];
 
     /**
      * Weather icon identifier
@@ -645,6 +649,80 @@ export type PickDataHashPropsByType<U, Strict = true> = Pick<
     }[keyof DataHash]
 >;
 
+export interface AirQDataHash extends IsDay {
+    /**
+     * Timestamp of beginning of segment
+     */
+    ts: Timestamp[];
+
+    /**
+     * Day identifier
+     */
+    day: YearMonthDay[];
+
+    /**
+     * Local Time hour for given place in 24h format
+     */
+    hour: Hours[];
+
+    /**
+     * CAMS airq properties
+     */
+    aqiUs: NumValue[];
+    /**
+     * Concentration of carbon monoxide (CO) in the air.
+     */
+    chemsCosc: NumValue[];
+    /**
+     * Concentration of dust particles (coarse particulate matter) in the air.
+     */
+    chemsDustsm: NumValue[];
+    /**
+     * Concentration of sulfur dioxide (SO2) in the air.
+     */
+    chemsSo2sm: NumValue[];
+    /**
+     * Ground-level ozone (O3) concentration.
+     */
+    go3: NumValue[];
+    /**
+     * Nitrogen dioxide (NO2) concentration.
+     */
+    no2: NumValue[];
+    /**
+     * Particulate matter with a diameter of 10 micrometers or less.
+     */
+    pm10: NumValue[];
+    /**
+     * Particulate matter with a diameter of 2.5 micrometers or less.
+     */
+    pm2p5: NumValue[];
+    /**
+     * Concentration of Alder pollen.
+     */
+    pollenAlder?: NumValue[];
+    /**
+     * Concentration of Birch pollen.
+     */
+    pollenBirch?: NumValue[];
+    /**
+     * Concentration of Grass pollen.
+     */
+    pollenGrass?: NumValue[];
+    /**
+     * Concentration of Mugwort pollen.
+     */
+    pollenMugwort?: NumValue[];
+    /**
+     * Concentration of Olive pollen.
+     */
+    pollenOlive?: NumValue[];
+    /**
+     * Concentration of Ragweed pollen.
+     */
+    pollenRagweed?: NumValue[];
+}
+
 /**
  * node-forecast header object
  */
@@ -772,7 +850,9 @@ export interface WeatherDataNow {
 /**
  * Weather data or Summary Weather data JSON as received from node-forecast
  */
-export interface WeatherDataPayload<T extends DataHash | SummaryDataHash> {
+export interface WeatherDataPayload<
+    T extends DataHash | SummaryDataHash | AirQDataHash = DataHash,
+> {
     header: NodeForecastHeader;
     celestial: Celestial;
     summary: Record<YearMonthDay, SummaryDay>;
@@ -837,7 +917,7 @@ export type WeatherTableRenderingOptions = {
      * Should we use 12h format for time?
      */
     is12hFormat?: boolean;
-} & Pick<DetailParams, 'display' | 'step' | 'rows' | 'days'>;
+} & Pick<DetailParams, 'display' | 'step' | 'days'>;
 
 /**
  * Parameters used for displaying detail (point forecast)
@@ -1147,7 +1227,8 @@ export interface WindyServicePlugin {
     getGoogleServicesAvailability: () => Promise<GoogleServicesPreferences>;
     getWidgetNotificationPermissions: () => Promise<WidgetNotificationPreferences>;
     openWidgetNotificationSettings: () => Promise<void>;
-    getBackgroundLocationPermission: () => Promise<GpsPreferences>;
+    getBackgroundLocationPermission: () => Promise<BatteryPreferences>;
+    getBatteryStatus: () => Promise<BatteryPreferences>;
     openBackgroundLocationSettings: () => Promise<void>;
     logError: (arg: { moduleName: string; msg: string; error?: string }) => Promise<void>;
     getId: () => Promise<{ identifier: string }>;
@@ -1651,6 +1732,95 @@ export interface ActiveStormCountPayload {
 }
 
 /**
+ * These properties are passed directly to renderer by enhancing returned params
+ */
+interface RenderParams {
+    /**
+     * Which channels contain tile rendering data
+     */
+    renderFrom?: RenderChannels;
+
+    /**
+     * Not confirmed: Display map as a sea, meaning the sea layers are below surface layers
+     */
+    sea?: boolean;
+
+    /**
+     * Display map as a land, meaning the sea area is hidden with mask
+     */
+    landOnly?: boolean;
+
+    /**
+     * Identifier of particle type
+     */
+    particlesIdent?: ParticlesIdent;
+
+    /**
+     * Uses two instances of Color for rendering
+     */
+    isMultiColor?: boolean;
+
+    /**
+     * Should green channel be interpolated to nearest discreet value
+     */
+    interpolateNearestG?: boolean;
+
+    /**
+     * Name of interpolator method
+     */
+    interpolate?: 'interpolateOverlay' | 'interpolateWaves';
+
+    /**
+     * Used patternator
+     */
+    pattern?: PatternType;
+}
+
+/**
+ * Set of params required to render the layer
+ */
+interface FullRenderParameters extends WeatherParameters, RenderParams {
+    layer: Layers;
+    JPGtransparency?: boolean;
+    PNGtransparency?: boolean;
+    transformR?: TransformFunction;
+    transformG?: TransformFunction;
+    transformB?: TransformFunction;
+    directory: string;
+
+    /**
+     * Specify zoom of mercator data tiles in dependence of map zoom
+     */
+    dataQuality?: DataQuality;
+    maxTileZoom?: {
+        free: number;
+        premium: number;
+    };
+
+    /**
+     * bump data quality by 1 level for particular overlay/layer
+     */
+    upgradeDataQuality?: boolean;
+
+    /**
+     * Force to select particular zoom of data tiles
+     */
+    dataTilesZoom?: number;
+
+    level: Levels;
+    refTime: Path;
+    fullPath: string;
+    path: Path;
+
+    /**
+     * Optional accumulation range in hours
+     */
+    acRangeInHours?: number;
+
+    fileSuffix?: 'png' | 'jpg' | 'json';
+}
+
+/*
  * Cap alert was slided from left to right on startup screen
  */
 export interface CapAlertSlided {
@@ -1661,7 +1831,7 @@ export interface CapAlertSlided {
 /**
  * Handy payload or reusable data that helps to render Forecast Table
  */
-export interface WeatherTableRenderingData {
+export interface WeatherTableRenderingData<T extends DataHash | AirQDataHash = DataHash> {
     /**
      * Day identifiers, that were used in data object (above)
      */
@@ -1670,7 +1840,12 @@ export interface WeatherTableRenderingData {
     /**
      * Loaded data.data (modified later by splicing data arrays)
      */
-    data: DataHash;
+    data: T;
+
+    /**
+     * Type of the data above
+     */
+    dataType: 'forecast' | 'airq';
 
     /**
      * Length of used forecast as a umber of TD segments
@@ -1686,6 +1861,7 @@ export interface WeatherTableRenderingData {
     tsWidth: Timestamp;
     pxWidth: Pixel;
     px2ts: number;
+    tdWidth: Pixel;
 
     /**
      * UTC offset in hours
@@ -1707,3 +1883,8 @@ export interface WeatherTableRenderingData {
      */
     summary: Record<YearMonthDay, SummaryDay>;
 }
+
+export interface SimplifiedGetBoundsOptions {
+    animate?: boolean;
+    padding?: RequireAtLeastOne<PaddingOptions>;
+}

package/types/lang-files.d.ts

@@ -738,18 +738,6 @@ export interface FavsLangFile {
      * favs: Error loading your fav item. Try again later.
      */
     FAVS_LOADING_ERROR: string;
-    /**
-     * favs: Migrate all
-     */
-    FAVS_MIGRATE_ALL: string;
-    /**
-     * favs: You have a lot of alerts, do you want to migrate them all at once?
-     */
-    FAVS_MIGRATION_MASS_MIGRATION: string;
-    /**
-     * favs: We're improving our alert system! Migrate your alerts before {{date}} to continue receiving notifications.
-     */
-    FAVS_MIGRATION_WARNING: string;
     /**
      * favs: Not saved
      */
@@ -1094,6 +1082,10 @@ export interface MainLangFile {
      * Aerosol
      */
     AOD550: string;
+    /**
+     * Air quality index
+     */
+    AQI: string;
     /**
      * Archive
      */
@@ -1150,6 +1142,10 @@ export interface MainLangFile {
      * Click to change units
      */
     CLICK_ON_LEGEND: string;
+    /**
+     * Close archive
+     */
+    CLOSE_ARCHIVE: string;
     /**
      * Clouds, rain
      */
@@ -1234,6 +1230,10 @@ export interface MainLangFile {
      * Move the map to change the forecast location
      */
     DETAIL_DRAG_CHECKBOX: string;
+    /**
+     * Error loading wind data for this model
+     */
+    DETAIL_ERROR_LOADING_WIND_DATA: string;
     /**
      * Set up Windy Alert for this location and never miss your desired conditions.
      */
@@ -1334,6 +1334,10 @@ export interface MainLangFile {
      * Dust mass
      */
     DUSTSM: string;
+    /**
+     * Dust
+     */
+    DUSTSM_SHORT: string;
     /**
      * 1h forecast
      */
@@ -2002,10 +2006,6 @@ export interface MainLangFile {
      * {{count}} more
      */
     MORE_PRODUCTS: string;
-    /**
-     * Plugin {{title}} is not installed. Do you want to install it?
-     */
-    MSG_EXTERNAL_PLUGIN_NOT_INSTALLED: string;
     /**
      * Unfortunately, plugin {{title}} was unpublished by the author and is no longer available.
      */
@@ -2014,6 +2014,10 @@ export interface MainLangFile {
      * New version of the plugin {{title}} is available. Do you want to update?
      */
     MSG_EXTERNAL_PLUGIN_UPDATE_AVAILABLE: string;
+    /**
+     * Close other Windy.com tabs and reload to update to the new version
+     */
+    MSG_INSTALLING_NEW_VERSION: string;
     /**
      * You have successfully logged in!
      */
@@ -2206,6 +2210,10 @@ export interface MainLangFile {
      * Period
      */
     PERIOD: string;
+    /**
+     * Play with forecast
+     */
+    PLAY_WITH_FORECAST: string;
     /**
      * Are you sure you want to uninstall this plugin?
      */
@@ -2322,6 +2330,58 @@ export interface MainLangFile {
      * Reported wind
      */
     POI_WIND: string;
+    /**
+     * Pollen&AirQ
+     */
+    POLLEN_AIRQ: string;
+    /**
+     * Alder pollen
+     */
+    POLLEN_ALDER: string;
+    /**
+     * Alder
+     */
+    POLLEN_ALDER_SHORT: string;
+    /**
+     * Birch pollen
+     */
+    POLLEN_BIRCH: string;
+    /**
+     * Birch
+     */
+    POLLEN_BIRCH_SHORT: string;
+    /**
+     * Grass pollen
+     */
+    POLLEN_GRASS: string;
+    /**
+     * Grass
+     */
+    POLLEN_GRASS_SHORT: string;
+    /**
+     * Mugwort pol.
+     */
+    POLLEN_MUGWORT: string;
+    /**
+     * Mugwort
+     */
+    POLLEN_MUGWORT_SHORT: string;
+    /**
+     * Olive pollen
+     */
+    POLLEN_OLIVE: string;
+    /**
+     * Olive
+     */
+    POLLEN_OLIVE_SHORT: string;
+    /**
+     * Ragweed pol.
+     */
+    POLLEN_RAGWEED: string;
+    /**
+     * Ragwe.
+     */
+    POLLEN_RAGWEED_SHORT: string;
     /**
      * Position
      */
@@ -3104,14 +3164,18 @@ export interface LivealertsLangFile {
      * livealerts: Download the app here
      */
     LIVE_ALERTS_DOWNLOAD_APP: string;
+    /**
+     * livealerts: To get alerts for your area, allow unrestricted battery usage in settings.
+     */
+    LIVE_ALERTS_ERROR_BATTERY_PERMISSION: string;
     /**
      * livealerts: Enable location access to receive live alerts for your current area.
      */
-    LIVE_ALERTS_ERROR_NOTDEFINED_LOCATION: string;
+    LIVE_ALERTS_ERROR_NOT_DETERMINED_LOCATION: string;
     /**
      * livealerts: Enable notifications to get live alerts
      */
-    LIVE_ALERTS_ERROR_NOTDEFINED_NOTIFICATIONS: string;
+    LIVE_ALERTS_ERROR_NOT_DETERMINED_NOTIFICATIONS: string;
     /**
      * livealerts: Live alerts are supported only on native Windy.com app
      */
@@ -3235,6 +3299,14 @@ export interface MenuLangFile {
      * menu: Pin to homepage
      */
     MM_PIN_HOMEPAGE: string;
+    /**
+     * menu: Layers & POIs
+     */
+    MM_PIN_SWITCH_LAYERS: string;
+    /**
+     * menu: Forecast models
+     */
+    MM_PIN_SWITCH_MODELS: string;
     /**
      * menu: Install Windy Plugin
      */
@@ -3445,6 +3517,10 @@ export interface OnboardingLangFile {
      * onboarding: Confirm
      */
     ONBOARDING_CONFIRM: string;
+    /**
+     * onboarding: Continue
+     */
+    ONBOARDING_CONTINUE: string;
     /**
      * onboarding: Don't allow
      */
@@ -3715,6 +3791,14 @@ export interface RadsatLangFile {
      * radsat: Infra
      */
     RADSAT_INFRA: string;
+    /**
+     * radsat: More...
+     */
+    RADSAT_JUST_MORE: string;
+    /**
+     * radsat: More options...
+     */
+    RADSAT_MORE: string;
     /**
      * radsat: Next {hour}h
      */
@@ -3936,6 +4020,69 @@ export interface RegisterLangFile {
     YOU_MUST_AGREE: string;
 }
 
+export interface SearchLangFile {
+    /**
+     * search: Clear search history
+     */
+    SEARCH_CLEAR_HISTORY: string;
+    /**
+     * search: Paragliding spots provided by <a href="https://paraglidingearth.com/" target="_blank">Paragliding Earth</a>
+     */
+    SEARCH_DATA_PG_PROVIDER: string;
+    /**
+     * search: Surfing spots provided by <a href="https://www.stormrider.surf/" target="_blank">Stormrider</a>
+     */
+    SEARCH_DATA_SURF_PROVIDER: string;
+    /**
+     * search: Airports
+     */
+    SEARCH_FILTER_AIRPORTS: string;
+    /**
+     * search: All
+     */
+    SEARCH_FILTER_ALL: string;
+    /**
+     * search: Kite, Surf, WS
+     */
+    SEARCH_FILTER_KITE_SURF_WS: string;
+    /**
+     * search: Paragl.
+     */
+    SEARCH_FILTER_PARAGLIDING: string;
+    /**
+     * search: Webcams
+     */
+    SEARCH_FILTER_WEBCAMS: string;
+    /**
+     * search: Wx Stations
+     */
+    SEARCH_FILTER_WX_STATIONS: string;
+    /**
+     * search: No results found
+     */
+    SEARCH_NO_RESULTS_FOUND: string;
+    /**
+     * search: No results found for
+     */
+    SEARCH_NO_RESULTS_FOUND_FOR: string;
+    /**
+     * search: Airports can be found by <b>ICAO</b> or <b>IATA</b> code
+     */
+    SEARCH_TIP_AIRPORT: string;
+    /**
+     * search: Search for coordinates to display location on a map
+     */
+    SEARCH_TIP_COORDS: string;
+    /**
+     * search: Search for name of active <b>hurricane</b> or <b>tropical cyclone</b>
+     */
+    SEARCH_TIP_HURRICANE: string;
+    /**
+     * search: Use e.g. <b>"LAX JFK"</b> or <b>"LKPR LSZS"</b> to display flying route
+     */
+    SEARCH_TIP_ROUTE: string;
+}
+
 export interface SettingsLangFile {
     /**
      * settings: Widgets cannot access the location from the background. Please allow background location usage.
@@ -4049,14 +4196,6 @@ export interface SettingsLangFile {
      * settings: automatic
      */
     S_AUTOMATIC: string;
-    /**
-     * settings: Graphic compatibility mode
-     */
-    S_COMPATIBILITY_MODE: string;
-    /**
-     * settings: Disables some problematic modern graphics acceleration
-     */
-    S_COMPATIBILITY_MODE_NOTE: string;
     /**
      * settings: Contrast
      */
@@ -6313,7 +6452,7 @@ export interface WidgetspromoLangFile {
 }
 
 // prettier-ignore
-export interface PluginTranslations extends AccumulationsLangFile, AirportLangFile, AlertsLangFile, AppreviewLangFile, ArticlesLangFile, ConsentLangFile, DistanceLangFile, FavsLangFile, GarminLangFile, HurricanesLangFile, InfoLangFile, LibLangFile, LivealertsLangFile, MenuLangFile, NotificationsLangFile, OnboardingLangFile, ProductsLangFile, RadsatLangFile, RegisterLangFile, SettingsLangFile, SoundingLangFile, StationLangFile, StoriesLangFile, SubscriptionLangFile, WatchfaceLangFile, WebcamsLangFile, WidgetspromoLangFile {}
+export interface PluginTranslations extends AccumulationsLangFile, AirportLangFile, AlertsLangFile, AppreviewLangFile, ArticlesLangFile, ConsentLangFile, DistanceLangFile, FavsLangFile, GarminLangFile, HurricanesLangFile, InfoLangFile, LibLangFile, LivealertsLangFile, MenuLangFile, NotificationsLangFile, OnboardingLangFile, ProductsLangFile, RadsatLangFile, RegisterLangFile, SearchLangFile, SettingsLangFile, SoundingLangFile, StationLangFile, StoriesLangFile, SubscriptionLangFile, WatchfaceLangFile, WebcamsLangFile, WidgetspromoLangFile {}
 export interface Translations extends MainLangFile, PluginTranslations {}
 
 export interface SupportedLangFiles {
@@ -6337,6 +6476,7 @@ export interface SupportedLangFiles {
     products: ProductsLangFile;
     radsat: RadsatLangFile;
     register: RegisterLangFile;
+    search: SearchLangFile;
     settings: SettingsLangFile;
     sounding: SoundingLangFile;
     station: StationLangFile;