@windycom/plugin-devtools 3.0.1 → 3.0.2

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

@@ -20,7 +20,6 @@ import {
 
 import {
     MenuItems,
-    Path,
     PickerMobileTimeout,
     ShowableError,
     SubTier,
@@ -29,6 +28,7 @@ import {
     RouteMotionSpeed,
     UsedMapLibrary,
     UserInterest,
+    type ISOCountryCode,
 } from '@windy/types.d';
 
 import { MetricItem } from '@windy/Metric.d';
@@ -39,7 +39,8 @@ import type { SubscriptionInfo } from '@plugins/_shared/subscription-services/su
 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';
+import type { FavType } from '@windy/favs.d';
+import type RadarPlusCalendar from '@plugins/radar-plus/calendar/radarPlusCalendar';
 
 /**
  * Custom animation particles settings
@@ -73,6 +74,7 @@ export interface ReverseResult extends LatLon {
     lang: string;
     region?: string;
     country?: string;
+    cc?: ISOCountryCode;
     name: string;
     nameValid?: boolean;
 }
@@ -103,7 +105,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,6 +152,12 @@ 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;
 }
 
 export interface FeatureFlags {
@@ -211,12 +219,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
      */
@@ -272,11 +274,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
      */
@@ -345,16 +342,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)
      */
@@ -496,12 +483,8 @@ export interface DataSpecifications {
      */
     camsPreviews: DataSpecificationsObject<boolean>;
 
-    //
-    // CAP alerts
-    //
-
     /**
-     * Today, tomm, later
+     * Today, tomorrow, later
      */
     capDisplay: DataSpecificationsObject<'all' | 'today' | 'tomm' | 'later'>;
 
@@ -624,7 +607,7 @@ export interface DataSpecifications {
     zuluMode: DataSpecificationsObject<boolean>;
 
     /**
-     * Sorting of nearest weater stations
+     * Sorting of nearest weather stations
      * @ignore
      */
     stationsSort: DataSpecificationsObject<'profi' | 'distance'>;
@@ -792,7 +775,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>;
 
@@ -801,6 +784,11 @@ export interface DataSpecifications {
      */
     radsatTimestamp: DataSpecificationsObject<Timestamp>;
 
+    /**
+     * RadarPlus calendar
+     */
+    radarPlusCalendar: DataSpecificationsObject<RadarPlusCalendar | null>;
+
     /**
      * Display this type of WX stations on POI map
      * @ignore
@@ -881,7 +869,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
@@ -904,6 +892,16 @@ export interface DataSpecifications {
      * User has enabled advanced features in debug console
      */
     advancedDebugConsole: DataSpecificationsObject<boolean>;
+
+    /**
+     * Installed version of windy idb
+     */
+    installedIdbVersion: DataSpecificationsObject<number>;
+
+    /**
+     * Active tab in pin menu (fav-layers plugin)
+     */
+    pinMenuActiveTab: DataSpecificationsObject<'models' | 'layers'>;
 }
 
 /**
@@ -924,7 +922,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/http.d.ts

@@ -59,6 +59,11 @@ export interface HttpOptions {
      * Custom headers object
      */
     customHeaders?: Record<string, string>;
+
+    /**
+     * Use already prepared and ongoing fetch requests if available
+     */
+    ongoingFetchRequest?: ReturnType<typeof fetch>;
 }
 
 /**

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

@@ -15,7 +15,6 @@ type AllowedDataSpecifications = Pick<
     | 'particles'
     | 'numDirection'
     | 'lang'
-    | 'disableWebGL'
     | 'graticule'
     | 'particlesAnim'
     | 'timestamp'

package/types/client/d.ts.files/plugin-params.d.ts

@@ -1,7 +1,10 @@
 import { Fav, FavId } from '@windy/favs.d';
 import { StartupArticleData, WhatsNewData } from '@windy/startup.d';
-import { HiddenReasonType, ReasonTypes } from '@plugins/subscription/subscription';
-import { FullRenderParameters } from '@windy/Layer.d';
+import {
+    HiddenReasonType,
+    ReasonTypes,
+    SubscriptionSource,
+} from '@plugins/subscription/subscription';
 import { HttpPayload } from '@windy/http.d';
 import {
     CapAlertHeadline,
@@ -11,6 +14,7 @@ import {
     PickerCoords,
     SummaryDataHash,
     WeatherDataPayload,
+    FullRenderParameters,
 } from '@windy/interfaces.d';
 import { Pois, Products } from '@windy/rootScope.d';
 import { SingleClickParams } from '@windy/singleclick.d';
@@ -25,7 +29,6 @@ import { WebcamCategoryType } from '@windy/webcams';
 
 import type { StoryPreview } from '@plugins/stories/stories.d';
 import type { StationDisplayType } from '@plugins/station/station';
-import type { PluginsListResponseDto } from '@plugins/external-plugins/external-plugins';
 
 /**
  * Type of source event, that led to opening any plugin
@@ -108,7 +111,8 @@ type RplannerDistanceParams =
     | {
           import: boolean;
           content: string;
-      }; // Uploaded GPX
+      } // Uploaded GPX
+    | undefined;
 
 export type PickerOpenParams =
     | (PluginSource &
@@ -121,7 +125,7 @@ export type PluginsOpenParams = {
     detail: DetailOpenParams;
     picker: PickerOpenParams;
     'picker-mobile': PickerOpenParams;
-    favs: PluginSource & { importObsoleteFavs?: boolean };
+    favs: PluginSource;
     station: PluginSource & {
         id: string;
         moveToTimestamp?: Timestamp;
@@ -145,16 +149,20 @@ export type PluginsOpenParams = {
             name?: string;
         };
     contextmenu: PluginSource & LatLon & { containerPoint?: L.Point };
+
+    /**
+     * Typing is incorrect here. If called from ClickHandler it has a string as params
+     */
     subscription:
-        | (PluginSource & {
-              promote?: ReasonTypes | HiddenReasonType;
-              pendingError?: Error & { responseText: string };
-          })
-        | undefined;
+        | PluginSource
+        | (PluginSource &
+              (
+                  | { promote?: ReasonTypes | HiddenReasonType; subsSource: SubscriptionSource }
+                  | { pendingError: Error & { responseText: string } }
+              ));
     'alerts-edit': PluginSource &
         (
             | { action: 'edit'; id: string }
-            | { action: 'migration'; favId: string }
             | {
                   action: 'new';
                   lat: number;
@@ -174,11 +182,7 @@ export type PluginsOpenParams = {
     'nearest-webcams-mobile': PluginSource & LatLon;
     'nearest-webcams': PluginSource & LatLon;
     'external-plugins':
-        | (PluginSource & {
-              id?: string;
-              qs?: PluginsQsParams['external-plugins'];
-              installPlugin?: PluginsListResponseDto;
-          })
+        | (PluginSource & { id?: string; qs?: PluginsQsParams['external-plugins'] })
         | undefined;
     sounding: PluginSource & LatLon & { name?: string };
     radiosonde: PluginSource & { id: string; lat?: number; lon?: number };

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

@@ -91,8 +91,6 @@ export interface SveltePlugins {
 
 export interface PlainPlugins {
     'gl-particles': Plugin<'gl-particles'>;
-    'legacy-tile-render': Plugin<'legacy-tile-render'>;
-    particles: Plugin<'particles'>;
     isolines: Plugin<'isolines'>;
 }
 

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

@@ -23,3 +23,5 @@ export type SupportedLanguages = (typeof import('./rootScope').supportedLanguage
 export type Pois = keyof typeof import('./rootScope').pois;
 
 export type Isolines = (typeof import('./rootScope').isolinesType)[number];
+
+export type PollenProducts = keyof typeof import('./rootScope').pollenProducts;

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

@@ -1,6 +1,6 @@
+import { HttpPayload } from '@windy/http.d';
 import { LatLon } from '@windy/interfaces.d';
 import { Timestamp } from '@windy/types.d';
-import { HttpPayload } from '@windy/http.d';
 
 export type WebcamCategoryType =
     | 'landscape'
@@ -75,7 +75,6 @@ export interface WebcamImageUrls {
     normal: string;
     original: string;
     preview: string;
-    teaserbg: string;
     thumbnail: string;
     webcam: string;
 }
@@ -83,6 +82,8 @@ export interface WebcamImageUrls {
 export type WebcamImageSize = keyof WebcamImageUrls;
 
 export type WebcamTimelapseType = 'day' | 'current' | 'all';
+
+// FIXME TODO: This type does not correspond to output form a backend. Fix the type
 export interface WebcamDetail {
     categories: WebcamCategoryType[];
     contacts: { owner: string; caretaker: string };
@@ -153,6 +154,12 @@ export interface WebcamLastUpdatedOn {
     lastUpdatedOn: number[];
 }
 
+export interface WebcamImageRequestParams {
+    webcamId: string | number;
+    state?: 'current' | 'daylight';
+    size?: WebcamImageSize;
+}
+
 export interface WebcamMetadata {
     updateString: string;
     recencyClass: string;

package/types/client/dataLoader.d.ts

@@ -1,8 +1,8 @@
 /**
  * Loader service for new rendering engine
  */
-import type { TransformFunction } from '@windy/Layer.d';
-import type { TileParams } from '@windy/Renderer.d';
+import type { TransformFunction } from '@windy/types';
+import type { TileParams } from '@windy/Renderer';
 export declare class DataTile {
     url: string;
     status: 'undefined' | 'loaded' | 'loading' | 'failed';

package/types/client/detectDevice.d.ts

@@ -1,3 +1,6 @@
 import type { Device, Platform } from '@windy/types.d';
 export declare const platform: Platform;
+/**
+ * The value of current device type (mobile, tablet, desktop)
+ */
 export declare const device: Device;

package/types/client/embed.d.ts

@@ -47,7 +47,6 @@ export * as trans from './services/trans';
 export * as query from './ui/query';
 export * as rhMessage from './ui/rhMessage';
 export * as BottomSlide from './uiClasses/BottomSlide';
-export * as ClickHandler from './uiClasses/ClickHandler';
 export * as Drag from './uiClasses/Drag';
 export * as Swipe from './uiClasses/Swipe';
 export * as Window from './uiClasses/Window';
@@ -65,6 +64,5 @@ export * as models from './weather/models';
 export { default as products } from './weather/products';
 export * as Calendar from './weatherClasses/Calendar';
 export * as Color from './weatherClasses/Color';
-export * as IconProducts from './weatherClasses/IconProducts';
 export { default as GlObj } from './wgUtils/GlObj';
 export { $, bcast as broadcast, ga, overlays, store };

package/types/client/errorLogger.d.ts

@@ -13,7 +13,7 @@ interface ErrorPayload {
     platform: Platform;
     device: Device;
     ver: string;
-    target: 'index' | 'mobile' | 'embed' | 'lib' | 'imaker';
+    target: 'index' | 'mobile' | 'embed' | 'lib';
     msg: string;
     timestamp: Timestamp;
     runningMinutes: number;

package/types/client/externalPlugins.d.ts

@@ -1,6 +1,8 @@
+import { ExternalSveltePlugin } from '@windy/ExternalSveltePlugin';
 import type { InstalledExternalPluginConfig } from '@windy/interfaces.d';
 export type ExternalPluginError = {
     type: 'network' | 'installation' | 'open';
     msg: string;
 };
 export declare const installExternalPlugin: (url: string, installedBy: InstalledExternalPluginConfig['installedBy']) => Promise<InstalledExternalPluginConfig | ExternalPluginError>;
+export declare const loadExternalPlugins: (forceReload?: boolean) => Promise<ExternalSveltePlugin[]>;

package/types/client/fetch.d.ts

@@ -10,10 +10,14 @@
  */
 import * as http from '@windy/http';
 import type { CityTemperaturesDto } from '@windy-types/citytile2';
-import type { DataHash, LatLon, MeteogramDataPayload, WeatherDataPayload, CapAlertHeadline, ActiveStormCountPayload } from '@windy/interfaces.d';
+import type { DataHash, LatLon, MeteogramDataPayload, WeatherDataPayload, CapAlertHeadline, ActiveStormCountPayload, AirQDataHash } from '@windy/interfaces.d';
 import type { Pois, Products } from '@windy/rootScope.d';
-import type { ExtendedStationType, StationOrPoiType } from '@windy/types';
+import type { SatelliteInfoJson } from '@windy/satellite.d';
+import type { RadarMinifest } from '@plugins/radar/types';
+import type { ExtendedStationType, Pixel, StationOrPoiType } from '@windy/types';
+import type { OSMMapBounds } from '@plugins/search/search.d';
 import type { HttpOptions, HttpPayload, QueryStringSource } from '@windy/http.d';
+import type { StormListJSON } from '@plugins/_shared/hurricanes/types';
 interface LatLonStep extends LatLon {
     step?: number;
     interpolate?: boolean;
@@ -80,7 +84,7 @@ export declare const getPointForecastUrl: <T extends LatLonStep>(model: Products
  * @param httpOptions Additional HTTP options
  * @returns Promise with HTTP payload
  */
-export declare const getPointForecastData: <T extends LatLonStep>(model: Products, latLonStepInterpolate: T, pointForecastOptions?: Record<string, string>, httpOptions?: HttpOptions) => Promise<HttpPayload<WeatherDataPayload<DataHash>>>;
+export declare const getPointForecastData: <K extends DataHash | AirQDataHash = DataHash, T extends LatLonStep = LatLonStep>(model: Products, latLonStepInterpolate: T, pointForecastOptions?: Record<string, string>, httpOptions?: HttpOptions) => Promise<http.HttpPayload<WeatherDataPayload<K>>>;
 /**
  * Gets enhanced point forecast meteogram data for given location
  * @returns Promise with HTTP payload
@@ -125,10 +129,30 @@ export declare const getObservationsUrl: (type: ExtendedStationType, id: string,
 /**
  * Get URL for getting observations for a specific station in node-poi server
  */
-export declare const getObservationPoiUrl: (type: StationOrPoiType | 'stations', id: string) => string;
+export declare const getObservationPoiUrl: (type: StationOrPoiType | 'stations' | 'metars', id: string) => string;
 /**
  * Returns loading promise for cap alert headlines
  */
 export declare const getCapAlertsSummary: ({ lat, lon }: LatLon) => Promise<http.HttpPayload<CapAlertHeadline[]>>;
 export declare const getHurricanesCount: () => Promise<HttpPayload<ActiveStormCountPayload>>;
+/**
+ * Loads Satellite Product info
+ */
+export declare const getSatelliteInfo: () => Promise<HttpPayload<SatelliteInfoJson>>;
+/**
+ * Loads Radar Product info
+ */
+export declare const getRadarInfo: () => Promise<HttpPayload<RadarMinifest>>;
+export declare const getRadarArchiveInfo: () => Promise<HttpPayload<RadarMinifest>>;
+export declare const getSatelliteArchiveInfo: () => Promise<HttpPayload<SatelliteInfoJson>>;
+export declare const getRadarCoverage: () => Promise<HttpPayload<number[]>>;
+export declare const getHurricanesList: () => Promise<HttpPayload<StormListJSON>>;
+/**
+ * Returns URL for static map image. Max zoom level is 13
+ */
+export declare const getStaticMapImageUrl: (params: LatLon & {
+    zoom: 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13;
+    size: Pixel;
+    bounds?: OSMMapBounds;
+}) => string;
 export {};

package/types/client/format.d.ts

@@ -5,6 +5,7 @@
  */
 import type { DirectionFunction, HowOldOptions, TimeFormatFunction } from './d.ts.files/format.d';
 import type { Timestamp } from './d.ts.files/types';
+export declare const euTime: TimeFormatFunction;
 /**
  * Returns function for displaying hours (either 12,24h format) on a basis of locale store of a browser
  * US, UK, PH, CA, AU, NZ, IN, EG, SA, CO, PK, MY - AM,PM format

package/types/client/glTileRender.d.ts

@@ -1,5 +1,5 @@
 import type { ExtendedWebGLTexture, WebGLProgramObject } from '@windy/GlObj.d';
-import type { TileParams } from '@windy/Renderer.d';
+import type { TileParams } from '@windy/Renderer';
 import type { TileLayerCanvas } from '@windy/TileLayerCanvas.d';
 import type { DataTile } from '@windy/dataLoader';
 export type Gradient = {
@@ -136,12 +136,6 @@ declare class TileRenderer {
      * @returns texture with additional params
      */
     private createGradientObject;
-    /**
-     * Predefined alpha values are set to gradient and then color array is generated
-     * (solution for user gradient colors with bad alpha)
-     * @param colorObj
-     */
-    private augmentRainCoverColorsWithAlpha;
     /**
      * Prepare color gradient(s) for layer
      * @param layer