@windycom/plugin-devtools 3.0.0 → 3.0.2

package/types/types.d.ts

@@ -11,19 +11,20 @@ export * from '@windy/interpolatorTypes.d';
 export type ISODateString = string;
 
 /**
- * Timestamp or any time duration in ms
+ * Point in time expressed as milliseconds since Unix epoch (Date.now()).
+ * Use {@link TimeRangeMs} instead for durations/interval lengths.
  */
 export type Timestamp = number;
 
 /**
- * Path in a form of YYYY/MM/DD/HH or YYYYMMDDHH based on minifest/calendar version
+ * Time range / duration in milliseconds (NOT an absolute epoch timestamp)
  */
-export type Path = string;
+export type TimeRangeMs = number;
 
 /**
- * String in a form YYYYMMDDHH
+ * Path in a form of YYYYMMDDHH based on minifest/calendar version
  */
-export type YYYYMMDDHH = string;
+export type Path = string;
 
 /**
  * Valid subscription tiers
@@ -34,7 +35,7 @@ export type Platform = 'android' | 'ios' | 'desktop';
 
 export type Device = 'mobile' | 'tablet' | 'desktop';
 
-export type DetailDisplayType = 'table' | 'meteogram' | 'airgram' | 'waves' | 'wind';
+export type DetailDisplayType = 'table' | 'meteogram' | 'airgram' | 'waves' | 'wind' | 'airq';
 
 export type Directions = 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW';
 
@@ -130,12 +131,11 @@ export type MeteogramLevels =
     | '1000h'
     | 'surface';
 
-export type CapAlertSeverity /** moderate **/ =
-    | 'M'
-    /** severe **/
-    | 'S'
-    | /** extreme **/ 'E'
-    | /** unknown **/ 'A';
+export type CapAlertSeverity =
+    | 'M' /** moderate **/
+    | 'S' /** severe **/
+    | 'E' /** extreme **/
+    | 'A' /** unknown **/;
 
 export type CapAlertType =
     | 'T' /** thunderstorm **/
@@ -172,7 +172,14 @@ export type RouteMotionSpeed = {
 };
 
 export type LocationPreferences = {
-    status: 'notDetermined' | 'restricted' | 'denied' | 'authorized' | 'unknownState';
+    status:
+        | 'notDetermined' // Native popup asking for location permission, was not shown yet.
+        | 'restricted' // The user cannot change this app’s status, possibly due to active restrictions such as parental controls being in place.
+        | 'denied' // User disabled app permissions, turned off device location, or enabled Airplane mode.
+        | 'authorized' // Deprecated
+        | 'authorizedAlways' // This authorization allows you to use all location services and receive location events whether or not your app is in use.
+        | 'authorizedWhenInUse' // This authorization allows you to use location services only when your app is in the foreground.
+        | 'unknownState'; // Device may not have location services
 };
 
 export type NotificationPreferences = {
@@ -219,10 +226,6 @@ export type ShowableErrors = {
     closed: Set<string>;
 };
 
-export type MigrationResult = {
-    status: 'migrationNotPerformed' | 'migratingData' | 'migrationPerformed';
-};
-
 /**
  * Overlay categories used for better UI navigation (mobile/tablet)
  */
@@ -265,6 +268,7 @@ export type PickerMobileTimeout = '3' | '6' | '9' | '12' | 'always';
  */
 export type LogPaths =
     | keyof WeatherParameters
+    | 'path'
     | 'version'
     | 'plugin'
     | 'pois'
@@ -274,6 +278,7 @@ export type LogPaths =
     | 'promo'
     | 'airport'
     | 'appRating'
+    | 'appOpening'
     | 'articles'
     | 'detail2'
     | 'appsflyer'
@@ -282,7 +287,19 @@ export type LogPaths =
     | 'weather'
     | 'events'
     | 'locationPermissionPopup'
-    | 'widgetPromo';
+    | 'widgetPromo'
+    | 'storyEvent'
+    | 'garmin';
+
+export type LogEvents =
+    | 'logout'
+    | 'animation-started'
+    | 'user-logged'
+    | 'click-on-hp'
+    | 'article-event'
+    | 'displayed-on-hp'
+    | 'subs-opened'
+    | 'subs-purchased';
 
 /**
  * Type of user consent
@@ -373,6 +390,18 @@ export interface WindyBackupPlugin {
  */
 export type UsedMapLibrary = 'leaflet' | 'maplibre' | 'globe';
 
+/**
+ * Time defined in hours
+ */
+export type Hours = number;
+
+export type Minutes = number;
+
+/**
+ * Time defined in seconds
+ */
+export type Seconds = number;
+
 /**
  * All defined translation keys
  *
@@ -380,11 +409,6 @@ export type UsedMapLibrary = 'leaflet' | 'maplibre' | 'globe';
  */
 export type LoadedTranslations = MainLangFile & PluginTranslations;
 
-/*
- * Time defined in hours
- */
-export type Hours = number;
-
 export type UserInterest =
     | 'outdoor_activities'
     | 'water_sports'
@@ -395,3 +419,308 @@ export type UserInterest =
     | 'agriculture'
     | 'meteorologist'
     | 'other';
+
+export type ParticlesIdent = 'wind' | 'waves' | 'currents';
+
+export type PatternType = 'cclPattern' | 'rainPattern' | 'ptypePattern';
+
+export type TransformFunction = (x: NumValue) => NumValue;
+
+export type RenderChannels = 'R' | 'RG' | 'B';
+
+export type ParsedQueryString = Record<string, string | undefined>;
+
+export type Size = 'xxs' | 'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl' | 'xxxl' | 'ultra';
+
+export type RGBA = [number, number, number, number];
+
+export type YUVA = [number, number, number, number];
+
+export type ColorGradient = [NumValue, RGBA][];
+
+export type ColorGradientString = [NumValue, RGBString | RGBAString][];
+
+/**
+ * 'rgb(200,0,150)'
+ */
+export type RGBString = `rgb(${number},${number},${number})`;
+
+/**
+ * 'rgba(200,0,150,1)'
+ */
+export type RGBAString = `rgba(${number},${number},${number},${number})`;
+
+/**
+ * Custom app icon for Premium users
+ */
+export type CustomAppIcon =
+    | 'aviation'
+    | 'boating'
+    | 'cycling'
+    | 'default'
+    | 'hiking'
+    | 'outdoor'
+    | 'paragliding'
+    | 'premium'
+    | 'running'
+    | 'scientist'
+    | 'swimming'
+    | 'water-sports'
+    | 'wind'
+    | 'windsurfing'
+    | 'winter-sports';
+
+/**
+ * All ISO 3166-1 alpha-2 country codes (current), lowercase.
+ * TODO: Later on properly type all the country codes in the codebase, where we uae string now
+ */
+export type ISOCountryCode =
+    | 'ad'
+    | 'ae'
+    | 'af'
+    | 'ag'
+    | 'ai'
+    | 'al'
+    | 'am'
+    | 'ao'
+    | 'aq'
+    | 'ar'
+    | 'as'
+    | 'at'
+    | 'au'
+    | 'aw'
+    | 'ax'
+    | 'az'
+    | 'ba'
+    | 'bb'
+    | 'bd'
+    | 'be'
+    | 'bf'
+    | 'bg'
+    | 'bh'
+    | 'bi'
+    | 'bj'
+    | 'bl'
+    | 'bm'
+    | 'bn'
+    | 'bo'
+    | 'bq'
+    | 'br'
+    | 'bs'
+    | 'bt'
+    | 'bv'
+    | 'bw'
+    | 'by'
+    | 'bz'
+    | 'ca'
+    | 'cc'
+    | 'cd'
+    | 'cf'
+    | 'cg'
+    | 'ch'
+    | 'ci'
+    | 'ck'
+    | 'cl'
+    | 'cm'
+    | 'cn'
+    | 'co'
+    | 'cr'
+    | 'cu'
+    | 'cv'
+    | 'cw'
+    | 'cx'
+    | 'cy'
+    | 'cz'
+    | 'de'
+    | 'dj'
+    | 'dk'
+    | 'dm'
+    | 'do'
+    | 'dz'
+    | 'ec'
+    | 'ee'
+    | 'eg'
+    | 'eh'
+    | 'er'
+    | 'es'
+    | 'et'
+    | 'fi'
+    | 'fj'
+    | 'fk'
+    | 'fm'
+    | 'fo'
+    | 'fr'
+    | 'ga'
+    | 'gb'
+    | 'gd'
+    | 'ge'
+    | 'gf'
+    | 'gg'
+    | 'gh'
+    | 'gi'
+    | 'gl'
+    | 'gm'
+    | 'gn'
+    | 'gp'
+    | 'gq'
+    | 'gr'
+    | 'gs'
+    | 'gt'
+    | 'gu'
+    | 'gw'
+    | 'gy'
+    | 'hk'
+    | 'hm'
+    | 'hn'
+    | 'hr'
+    | 'ht'
+    | 'hu'
+    | 'id'
+    | 'ie'
+    | 'il'
+    | 'im'
+    | 'in'
+    | 'io'
+    | 'iq'
+    | 'ir'
+    | 'is'
+    | 'it'
+    | 'je'
+    | 'jm'
+    | 'jo'
+    | 'jp'
+    | 'ke'
+    | 'kg'
+    | 'kh'
+    | 'ki'
+    | 'km'
+    | 'kn'
+    | 'kp'
+    | 'kr'
+    | 'kw'
+    | 'ky'
+    | 'kz'
+    | 'la'
+    | 'lb'
+    | 'lc'
+    | 'li'
+    | 'lk'
+    | 'lr'
+    | 'ls'
+    | 'lt'
+    | 'lu'
+    | 'lv'
+    | 'ly'
+    | 'ma'
+    | 'mc'
+    | 'md'
+    | 'me'
+    | 'mf'
+    | 'mg'
+    | 'mh'
+    | 'mk'
+    | 'ml'
+    | 'mm'
+    | 'mn'
+    | 'mo'
+    | 'mp'
+    | 'mq'
+    | 'mr'
+    | 'ms'
+    | 'mt'
+    | 'mu'
+    | 'mv'
+    | 'mw'
+    | 'mx'
+    | 'my'
+    | 'mz'
+    | 'na'
+    | 'nc'
+    | 'ne'
+    | 'nf'
+    | 'ng'
+    | 'ni'
+    | 'nl'
+    | 'no'
+    | 'np'
+    | 'nr'
+    | 'nu'
+    | 'nz'
+    | 'om'
+    | 'pa'
+    | 'pe'
+    | 'pf'
+    | 'pg'
+    | 'ph'
+    | 'pk'
+    | 'pl'
+    | 'pm'
+    | 'pn'
+    | 'pr'
+    | 'ps'
+    | 'pt'
+    | 'pw'
+    | 'py'
+    | 'qa'
+    | 're'
+    | 'ro'
+    | 'rs'
+    | 'ru'
+    | 'rw'
+    | 'sa'
+    | 'sb'
+    | 'sc'
+    | 'sd'
+    | 'se'
+    | 'sg'
+    | 'sh'
+    | 'si'
+    | 'sj'
+    | 'sk'
+    | 'sl'
+    | 'sm'
+    | 'sn'
+    | 'so'
+    | 'sr'
+    | 'ss'
+    | 'st'
+    | 'sv'
+    | 'sx'
+    | 'sy'
+    | 'sz'
+    | 'tc'
+    | 'td'
+    | 'tf'
+    | 'tg'
+    | 'th'
+    | 'tj'
+    | 'tk'
+    | 'tl'
+    | 'tm'
+    | 'tn'
+    | 'to'
+    | 'tr'
+    | 'tt'
+    | 'tv'
+    | 'tw'
+    | 'tz'
+    | 'ua'
+    | 'ug'
+    | 'um'
+    | 'us'
+    | 'uy'
+    | 'uz'
+    | 'va'
+    | 'vc'
+    | 've'
+    | 'vg'
+    | 'vi'
+    | 'vn'
+    | 'vu'
+    | 'wf'
+    | 'ws'
+    | 'ye'
+    | 'yt'
+    | 'za'
+    | 'zm'
+    | 'zw';

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

@@ -1,96 +0,0 @@
-import { Timestamp, ISODateString, LoadedTranslations } from '@windy/types.d';
-
-/**
- * Main minifest object. Mother of all forecasts
- */
-export interface MinifestObject {
-    /**
-     * Version
-     */
-    v: string;
-
-    /**
-     * Array of hour moments that contain forecast data
-     */
-    dst: number[][];
-
-    /**
-     * Main identifier, identifiing the refTime on the backend.
-     */
-    info: string;
-
-    /**
-     * Reference time of forecast
-     */
-    ref: ISODateString;
-
-    /**
-     * Update time of the forecast
-     */
-    update: ISODateString;
-
-    /**
-     * In an emergency case backend can set `force` property at minifest. It breaks minifest client cache and set minifest at any circumstances
-     */
-    forced?: boolean;
-}
-
-/**
- * Main Calendar Day Object
- */
-export interface CalendarDay {
-    /**
-     * Translation ID for week day abbreviation
-     */
-    display: keyof LoadedTranslations;
-
-    /**
-     * Translation ID for week day abbreviation
-     */
-    displayLong: keyof LoadedTranslations;
-
-    /**
-     * Start of the day
-     */
-    start: Timestamp;
-
-    /**
-     * End of the day
-     */
-    end: Timestamp;
-
-    /**
-     * Midday of the day
-     */
-    middayTs: Timestamp;
-
-    /**
-     * Day of the month
-     */
-    day: number;
-
-    /**
-     * month
-     */
-    month: number;
-
-    /**
-     * year
-     */
-    year: number;
-
-    /**
-     * Forecast for this day is for Premium users only
-     */
-    premium: boolean;
-
-    /**
-     * Forecast for this day is available
-     */
-    hasForecast: boolean;
-}
-
-/**
- * Valid translation keys
- */
-export type Weekday = 'SUN' | 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT';

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

@@ -1,93 +0,0 @@
-import { NumValue } from '@windy/types.d';
-
-export type RGBA = [number, number, number, number];
-
-export type YUVA = [number, number, number, number];
-
-export type ColorGradient = [NumValue, RGBA][];
-
-/**
- * 'rgb(200,0,150)'
- */
-export type RGBString = string;
-
-/**
- * 'rgba(200,0,150,1)'
- */
-export type RGBAString = string;
-
-export type ColorIdent =
-    | 'temp'
-    | 'wind'
-    | 'rh'
-    | 'pressure'
-    | 'cclAltitude'
-    | 'altitude'
-    | 'deg0'
-    | 'levels'
-    | 'rain'
-    | 'ptype'
-    | 'rainClouds'
-    | 'clouds'
-    | 'lclouds'
-    | 'hclouds'
-    | 'mclouds'
-    | 'cape'
-    | 'lightDensity'
-    | 'cbase'
-    | 'snow'
-    | 'rainAccu'
-    | 'waves'
-    | 'currents'
-    | 'visibility'
-    | 'gtco3'
-    | 'aod550'
-    | 'pm2p5'
-    | 'no2'
-    | 'tcso2'
-    | 'go3'
-    | 'cosc'
-    | 'dust'
-    | 'satellite'
-    | 'radar'
-    | 'radarPlus'
-    | 'fog'
-    | 'justGray'
-    | 'efiWind'
-    | 'efiTemp'
-    | 'efiRain'
-    | 'moistureAnom40'
-    | 'moistureAnom100'
-    | 'drought'
-    | 'soilMoisture'
-    | 'fwi'
-    | 'dfm10h'
-    | 'solarpower'
-    | 'uvindex'
-    | 'turbulence'
-    | 'icing'
-    | 'wetbulbtemp';
-
-type PluginColorIdent =
-    | 'airQ'
-    | 'windDetail'
-    | 'wavesDetail'
-    | 'periodDetail'
-    | 'altitudeDetail'
-    | 'visibilityDetail'
-    | 'dewpointSpreadDetail'
-    | 'blitz'
-    | 'radiation';
-
-// pressureIsolines color is dynamically created in @plugins/isolines
-export type AnyColorIdent =
-    | ColorIdent
-    | PluginColorIdent
-    | 'pressureIsolines'
-    | 'temporary'
-    | 'direction';
-
-export interface UserColor {
-    id: AnyColorIdent;
-    gradient: ColorGradient;
-}