@windycom/plugin-devtools 2.0.0 → 3.0.0

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

@@ -1,7 +1,5 @@
-import { OpenOptions } from '@capacitor/browser';
-import { ProviderConstructorParams } from '@plugins/_shared/subscription-services/subscription-services.d';
-import { FavEventTypes } from '@plugins/favs/favs.d';
-import { StartupArticleData, WhatsNewData } from '@plugins/startup/startup.d';
+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 { HttpPayload } from '@windy/http.d';
@@ -11,8 +9,6 @@ import {
     HomeLocation,
     LatLon,
     PickerCoords,
-    SavedAlertFav,
-    SavedFav,
     SummaryDataHash,
     WeatherDataPayload,
 } from '@windy/interfaces.d';
@@ -22,7 +18,8 @@ import {
     DetailDisplayType,
     RouteType,
     StationOrPoiType,
-    type ExternalPluginIdent,
+    ExternalPluginIdent,
+    type Timestamp,
 } from '@windy/types.d';
 import { WebcamCategoryType } from '@windy/webcams';
 
@@ -33,7 +30,6 @@ export type PluginOpenEventSource =
     | 'contextmenu'
     | 'hp'
     | 'url'
-    | 'sigleclick'
     | 'poi-icon'
     | 'search'
     | 'detail'
@@ -49,6 +45,7 @@ export type PluginOpenEventSource =
     | 'api'
     | 'last'
     | 'back-button'
+    | 'other'
     | 'label';
 
 export interface PluginSource {
@@ -56,7 +53,7 @@ export interface PluginSource {
     poiType?: StationOrPoiType | Pois | 'stations';
 }
 
-interface DetailOpenParams extends PluginSource, LatLon {
+export interface DetailOpenParams extends PluginSource, LatLon {
     /**
      * How to display detail
      */
@@ -83,16 +80,15 @@ interface DetailOpenParams extends PluginSource, LatLon {
     sourceEl?: HTMLElement;
 
     /**
-     * Detail was opened by clicking on Alert neotification so detail table should be scrolled to
+     * Detail was opened by clicking on Alert notification so detail table should be scrolled to
      * particular timestamp
      */
     moveToTimestamp?: boolean;
 
     /**
-     * Array of times, when Alert was triggered in a form of 897987987,098908089,09809098
-     * where numbers are timestamps / tsHour
+     * Array of timestamp, when Alert was triggered
      */
-    hrTimestamps?: string;
+    timestamps?: Timestamp[] | null;
 }
 
 type WebcamDetailOpenParams =
@@ -102,8 +98,9 @@ type WebcamDetailOpenParams =
     | undefined;
 
 type RplannerDistanceParams =
+    | { view: RouteType; coords: string; id: FavId; isFav: true } // Opening from favourites
     | { view?: RouteType; coords: string; id?: string } // Opening from URL
-    | SavedFav
+    | Fav
     // | RplannerOpeningAsFavs // Clicking on route stored as fav
     | LatLon[] // User puts two airports is search bar
     | (LatLon & {
@@ -125,12 +122,7 @@ export type PluginsOpenParams = {
     detail: DetailOpenParams;
     picker: PickerOpenParams;
     'picker-mobile': PickerOpenParams;
-    favs:
-        | (PluginSource & {
-              msg?: FavEventTypes;
-          })
-        | undefined;
-
+    favs: PluginSource & { importObsoleteFavs?: boolean };
     station: PluginSource & { id: string };
     multimodel: LatLon & PluginSource & { name?: string | null };
     webcams: (PluginSource & { category: WebcamCategoryType }) | undefined;
@@ -152,32 +144,27 @@ export type PluginsOpenParams = {
     contextmenu: PluginSource & LatLon & { containerPoint?: L.Point };
     subscription:
         | (PluginSource & {
-              fscNext?: string;
               promote?: ReasonTypes | HiddenReasonType;
               pendingError?: Error & { responseText: string };
           })
         | undefined;
-    alerts:
-        | (PluginSource & {
-              id?: string;
-              name?: string;
-              title?: string;
-              action?: 'new';
-              lat?: string | number;
-              lon?: string | number;
-          })
-        | (PluginSource & SavedAlertFav);
+    'alerts-edit': PluginSource &
+        (
+            | { action: 'edit'; id: string }
+            | { action: 'migration'; favId: string }
+            | {
+                  action: 'new';
+                  lat: number;
+                  lon: number;
+                  locationName?: string;
+              }
+        );
+    alerts: PluginSource & {
+        message?: string;
+    };
     distance: PluginSource & RplannerDistanceParams;
     rplanner: PluginSource & RplannerDistanceParams;
-    airport: PluginSource & {
-        // Airport plugin can receive ICAO code as id || icao property
-        icao?: string;
-        id?: string;
-    };
-    'save-password': PluginSource & {
-        username: string;
-        password: string;
-    };
+    airport: PluginSource & { id: string };
     share: undefined;
     'nearest-stations': PluginSource & LatLon & { compactVersion?: boolean; includeAirq?: boolean };
     'nearest-airq': PluginSource & LatLon;
@@ -186,10 +173,6 @@ export type PluginsOpenParams = {
     'external-plugins':
         | (PluginSource & { id?: string; qs?: PluginsQsParams['external-plugins'] })
         | undefined;
-    browser: PluginSource & {
-        options: OpenOptions;
-        onFinished?: () => void;
-    };
     sounding: PluginSource & LatLon & { name?: string };
     radiosonde: PluginSource & { id: string; lat?: number; lon?: number };
     startup: PluginSource;
@@ -216,10 +199,16 @@ export type PluginsOpenParams = {
               showSystemDialog?: boolean;
           })
         | undefined;
-    offline: PluginSource;
+    'location-permission':
+        | (PluginSource & {
+              resolve?: (value: boolean | PromiseLike<boolean>) => void;
+          })
+        | undefined;
     'developer-mode': (PluginSource & { qs: Record<string, string> | undefined }) | undefined;
     'windy-external-plugin': PluginSource & LatLon;
-    menu: PluginSource; // FIXME: This typing is not correct. Poi selector on HP is calling menu with string 'pois'
+    menu: PluginSource & { scrollTo?: 'pois' };
+    onboarding: (PluginSource & { getUserInterests?: boolean }) | undefined;
+    'heatmaps-redirect': PluginSource & { id?: string };
 } & {
     [external: ExternalPluginIdent]:
         | (PluginSource & { query: Record<string, string> | undefined })
@@ -228,7 +217,6 @@ export type PluginsOpenParams = {
 } & { [others: string]: undefined };
 
 export type PluginsQsParams = {
-    subscription: ProviderConstructorParams | undefined;
     'external-plugins': Record<string, string> | undefined;
     'developer-mode': Record<string, string> | undefined;
     detail: { hrTimestamps?: string; name?: string; moveToTimestamp?: string };

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

@@ -1,25 +1,21 @@
-import { BottomTagPlugin } from '@windy/BottomTagPlugin';
+import { BottomSveltePlugin } from '@windy/BottomSveltePlugins';
 import { Plugin } from '@windy/Plugin';
 import { SveltePanePlugin } from '@windy/SveltePanePlugin';
 import { SveltePlugin } from '@windy/SveltePlugin';
 import { TagPlugin } from '@windy/TagPlugin';
 
-export interface BottomTagPlugins {
-    accumulations: BottomTagPlugin<'accumulations'>;
-    radar: BottomTagPlugin<'radar'>;
-    satellite: BottomTagPlugin<'satellite'>;
-    'cap-alerts': BottomTagPlugin<'cap-alerts'>;
-    'day-switcher': BottomTagPlugin<'day-switcher'>;
+export interface BottomSveltePlugins {
+    'mobile-calendar'?: BottomSveltePlugin<'mobile-calendar'>;
+    'progress-bar'?: BottomSveltePlugin<'progress-bar'>;
 
-    // mobile only, not embed
-    'mobile-calendar'?: BottomTagPlugin<'mobile-calendar'>;
-
-    // embed or desktop only
-    'progress-bar'?: BottomTagPlugin<'progress-bar'>;
+    'day-switcher': BottomSveltePlugin<'day-switcher'>;
+    'cap-alerts': BottomSveltePlugin<'cap-alerts'>;
+    accumulations: BottomSveltePlugin<'accumulations'>;
 }
 
 export interface SveltePanePlugins {
     favs: SveltePanePlugin<'favs'>;
+    'alerts-edit': SveltePanePlugin<'alerts-edit'>;
     alerts: SveltePanePlugin<'alerts'>;
     colors: SveltePanePlugin<'colors'>;
     articles: SveltePanePlugin<'articles'>;
@@ -32,12 +28,12 @@ export interface SveltePanePlugins {
     radiosonde: SveltePanePlugin<'radiosonde'>;
     airport: SveltePanePlugin<'airport'>;
     info: SveltePanePlugin<'info'>;
-    offline: SveltePlugin<'offline'>;
     webcams: SveltePanePlugin<'webcams'>;
     'webcams-detail': SveltePanePlugin<'webcams-detail'>;
     'webcams-add': SveltePanePlugin<'webcams-add'>;
     'webcams-edit': SveltePanePlugin<'webcams-edit'>;
     'webcams-remove': SveltePanePlugin<'webcams-remove'>;
+
     uploader?: SveltePanePlugin<'uploader'>;
     'external-plugins'?: SveltePanePlugin<'external-plugins'>;
 }
@@ -58,18 +54,34 @@ export interface SveltePlugins {
     rplanner: SveltePlugin<'rplanner'>;
     menu: SveltePlugin<'menu'>;
     'fav-alert-menu': SveltePlugin<'fav-alert-menu'>;
+    radar: SveltePlugin<'radar'>;
+    satellite: SveltePlugin<'satellite'>;
+    'radar-plus': SveltePlugin<'radar-plus'>;
+    'map-selector': SveltePlugin<'map-selector'>;
 
     // Mobile/desktop only plugins
     distance?: SveltePlugin<'distance'>;
     'watch-faces'?: SveltePlugin<'watch-faces'>;
     'app-review-dialog'?: SveltePlugin<'app-review-dialog'>;
+    widgets?: SveltePlugin<'widgets'>;
     'fav-layers'?: SveltePlugin<'fav-layers'>;
+    onboarding?: SveltePlugin<'onboarding'>;
     'developer-mode'?: SveltePlugin<'developer-mode'>;
     'pin-to-homepage'?: SveltePlugin<'pin-to-homepage'>;
     'startup-whats-new'?: SveltePlugin<'startup-whats-new'>;
     'rhpane-top': SveltePlugin<'rhpane-top'>;
+    rhbottom?: SveltePlugin<'rhbottom'>;
+    'location-permission'?: SveltePlugin<'location-permission'>;
 
     'startup-weather'?: SveltePlugin<'startup-weather'>;
+    'mobile-ui'?: SveltePlugin<'mobile-ui'>;
+    'embed-ui'?: SveltePlugin<'embed-ui'>;
+    contextmenu?: SveltePlugin<'contextmenu'>;
+    upload: SveltePlugin<'upload'>;
+    screenshot: SveltePlugin<'screenshot'>;
+    search: SveltePlugin<'search'>;
+    'startup-articles'?: SveltePlugin<'startup-articles'>;
+    'picker-mobile'?: SveltePlugin<'picker-mobile'>; // to Svelte plugin
 
     // Used as fake plugin for any other external plugin
     // basically we are unable to type each individual external plugin
@@ -80,39 +92,15 @@ export interface PlainPlugins {
     'gl-particles': Plugin<'gl-particles'>;
     'legacy-tile-render': Plugin<'legacy-tile-render'>;
     particles: Plugin<'particles'>;
-    startup?: Plugin<'startup'>;
+    isolines: Plugin<'isolines'>;
 }
 
 export interface TagPlugins {
-    /**
-     * Libraries with possible CSS, that remains opened
-     */
-    rhbottom: TagPlugin<'rhbottom'>;
+    // These plugins have css only (no html)
     'poi-libs': TagPlugin<'poi-libs'>;
-
-    /**
-     * Tag Plugins
-     */
-    upload: TagPlugin<'upload'>;
-    screenshot: TagPlugin<'screenshot'>;
-    isolines: TagPlugin<'isolines'>;
-    search: TagPlugin<'search'>;
-
-    // not embed plugins
-    'startup-articles'?: TagPlugin<'startup-articles'>;
-
-    // desktop only plugins
-    contextmenu?: TagPlugin<'contextmenu'>;
     picker?: TagPlugin<'picker'>;
     globe?: TagPlugin<'globe'>;
-
-    // mobile only plugins
-    'picker-mobile'?: TagPlugin<'picker-mobile'>;
-    'promo-mobile-intro'?: TagPlugin<'promo-mobile-intro'>;
-    profile?: TagPlugin<'profile'>;
-    'save-password'?: TagPlugin<'save-password'>;
-    browser?: TagPlugin<'browser'>;
-    'map-selector'?: TagPlugin<'map-selector'>;
+    'heatmaps-redirect': TagPlugin<'heatmaps-redirect'>;
 }
 
 export interface Plugins
@@ -120,10 +108,10 @@ export interface Plugins
         SveltePlugins,
         SveltePanePlugins,
         PlainPlugins,
-        BottomTagPlugins {}
+        BottomSveltePlugins {}
 
 export interface WindowPlugins
     extends TagPlugins,
         SveltePlugins,
         SveltePanePlugins,
-        BottomTagPlugins {}
+        BottomSveltePlugins {}

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

@@ -1,6 +1,6 @@
 import type { DataSpecifications } from '@windy/dataSpecifications.d';
 import type { Pois } from '@windy/rootScope.d';
-import type { LoadedTranslations } from '@windy/trans.d';
+import type { LoadedTranslations } from '@windy/types';
 
 export type PoisCheckboxeDef = {
     checkboxTranslation?: keyof LoadedTranslations;

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

@@ -1,33 +1,43 @@
+import { AccessProduct, AccessCProduct } from '@windy/AccessProducts';
 import { AromeProduct } from '@windy/AromeProduct';
 import { EcmwfAnalysisProduct } from '@windy/EcmwfAnalysisProduct';
 import { EcmwfProduct } from '@windy/EcmwfProduct';
 import { Product } from '@windy/Product';
+import { RadarPlusProduct } from '@windy/RadarPlusProduct';
 import { SatelliteProduct } from '@windy/SatelliteProduct';
+
 import { Products } from '@windy/rootScope.d';
 
 export type products = Implements<
     { [P in Products]: Product },
     {
-        bomAccess: Product;
+        bomAccess: AccessProduct;
+        bomAccessAd: AccessCProduct;
+        bomAccessBn: AccessCProduct;
+        bomAccessDn: AccessCProduct;
+        bomAccessNq: AccessCProduct;
+        bomAccessPh: AccessCProduct;
+        bomAccessSy: AccessCProduct;
+        bomAccessVt: AccessCProduct;
         mblue: Product;
         ecmwf: EcmwfProduct;
         ecmwfWaves: Product;
-        ecmwfAifs: Product;
         ecmwfAnalysis: EcmwfAnalysisProduct;
         canHrdps: Product;
         canRdwpsWaves: Product;
         cams: Product;
         camsEu: Product;
         cmems: Product;
+        czeAladin: Product;
         gfs: Product;
         gfsWaves: Product;
         icon: Product;
         iconD2: Product;
         iconEu: Product;
         iconEuWaves: Product;
-        iconWaves: Product;
         arome: Product;
         aromeAntilles: AromeProduct;
+        aromeFrance: AromeProduct;
         aromeReunion: AromeProduct;
         nems: Product;
         namAlaska: Product;
@@ -37,6 +47,7 @@ export type products = Implements<
         efi: Product;
         radar: Product;
         satellite: SatelliteProduct;
+        radarPlus: RadarPlusProduct;
         hrrrAlaska: Product;
         hrrrConus: Product;
         ukv: Product;
@@ -45,5 +56,6 @@ export type products = Implements<
         activeFires: Product;
         jmaMsm: Product;
         jmaCwmWaves: Product;
+        topoMap: Product;
     }
 >;

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

@@ -2,8 +2,6 @@ export type Levels = typeof import('./rootScope').levels[number];
 
 export type Overlays = typeof import('./rootScope').overlays[number];
 
-export type AcTimes = typeof import('./rootScope').acTimes[number];
-
 export type LocalProducts = typeof import('./rootScope').localProducts[number];
 
 export type GlobalProducts = typeof import('./rootScope').globalProducts[number];
@@ -22,22 +20,6 @@ export type Products = typeof import('./rootScope').products[number];
 
 export type SupportedLanguages = typeof import('./rootScope').supportedLanguages[number];
 
-export type Pois =
-    | 'favs'
-    | 'cities'
-    | 'wind'
-    | 'temp'
-    | 'precip'
-    | 'metars'
-    | 'radiosonde'
-    | 'cams'
-    | 'pgspots'
-    | 'kitespots'
-    | 'surfspots'
-    | 'tide'
-    | 'radiation'
-    | 'firespots'
-    | 'airq'
-    | 'empty';
-
-export type Isolines = 'off' | 'pressure' | 'gh' | 'temp' | 'deg0';
+export type Pois = keyof typeof import('./rootScope').pois;
+
+export type Isolines = typeof import('./rootScope').isolinesType[number];

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

@@ -0,0 +1,59 @@
+import type { RelatedHomepageArticlesResponseDto } from '@plugins/articles/articles.d';
+import type { Timestamp } from '@windy/types';
+
+export type StartupNewsType = 'hp-article' | 'whats-new';
+
+export interface StartupItem {
+    type: StartupNewsType;
+}
+
+export interface StartupResponse {
+    'hp-articles'?: StartupArticleData[];
+    'whats-new'?: WhatsNewData;
+}
+
+export interface StartupArticleData extends RelatedHomepageArticlesResponseDto, StartupItem {
+    type: 'hp-article';
+}
+
+export interface WhatsNewData extends StartupItem {
+    type: 'whats-new';
+    id: string;
+    title: string;
+    contributors: {
+        name: string;
+        avatarUrl: string;
+    }[];
+    content: {
+        new?: string;
+        improved?: string;
+        fixed?: string;
+    };
+}
+
+export interface EnhancedStartupArticle extends StartupArticleData {
+    key: string;
+    count: number;
+    lastDisplayed: number;
+}
+
+/**
+ * Info about articles, user has already seen
+ */
+export interface SeenArticle {
+    /**
+     * Last time, the article has been displayed to the user
+     */
+    lastDisplayed: Timestamp;
+
+    /**
+     * How many times the article has been seen
+     * (one count is added only if the article has been seen after 12 hours from the last seen time)
+     */
+    count: number;
+
+    /**
+     * Marks beginning of 12h interval
+     */
+    seen: Timestamp;
+}

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

@@ -1,14 +1,9 @@
-import { MinifestObject } from '@windy/Calendar.d';
-import { Fav, LastSentDevice, SavedFav, SeenArticle } from '@windy/interfaces.d';
-import { StoredTransFile } from '@windy/trans.d';
 import { Timestamp } from '@windy/types.d';
-
-import LRUCache from './lruCache';
+import { Fav, type ObsoleteFav } from '@windy/favs.d';
+import { SearchRecent } from '@plugins/search/search';
 
 export interface StorageData {
-    /**
-     * Number of hits for every single promo2 id.
-     */
+    /** @deprecated  replaced by IDB */
     promos2?: Record<string, number>;
 
     /**
@@ -35,18 +30,6 @@ export interface StorageData {
      */
     rateDialogShown?: Timestamp;
 
-    lastSentDevice?: LastSentDevice;
-
-    /**
-     * Articles, user has seen on particular device
-     */
-    articles?: Record<string, SeenArticle>;
-
-    /**
-     * Airport detail offline cache
-     */
-    'offline/airport'?: ReturnType<LRUCache<string>['toJSON']>;
-
     /**
      * Used by dev plugin for plugins development
      */
@@ -54,27 +37,21 @@ export interface StorageData {
 
     version?: string;
 
-    // TODO - centralize all these template strings to the logic directly in their modules
-
     [key: `settings_${string}_ts`]: Timestamp | null;
 
-    [key: `lang/${string}.json`]: StoredTransFile | null;
-
-    [key: `favs${number}`]: Record<string, SavedFav> | null;
-
-    // TODO - remove this
-    [key: `favs${number}_overflowed`]: Record<string, SavedFav> | null;
-
-    [key: `favs${number}_ts`]: Timestamp | null;
-
-    [key: `recents${number}`]: Record<string, Fav> | null;
-
-    [key: `lastMinifest/${string}`]: MinifestObject | null;
-
     /**
      * Other dynamically add storage data
      */
     [ident: string]: unknown | null;
+
+    /** @deprecated & replaced by IDB */
+    [key: `recents${number}`]: Record<string, SearchRecent> | null;
+
+    /** @deprecated & replaced by IDB */
+    [key: `favs${number}`]: Record<string, Fav | ObsoleteFav> | null;
+
+    /** @deprecated & replaced by IDB */
+    [key: `favs${number}_ts`]: Timestamp | null;
 }
 
 export type StorageDataKey = keyof StorageData & string;

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

@@ -1,35 +1,56 @@
 import { SubscriptionInfo } from '@plugins/_shared/subscription-services/subscription-services.d';
-import { User } from '@windy/dataSpecifications.d';
-import { SubTier } from '@windy/types.d';
+import { SubTier, type ExternalPluginIdent } from '@windy/types.d';
+import { FavFragment } from '@windy/favs';
+import type { PluginsOpenParams } from '@windy/plugin-params';
+
+export interface User {
+    avatar?: string;
+    email?: string;
+    fullname?: string;
+    id: number;
+    username: string;
+    userslug: string;
+    verifiedEmail?: string;
+
+    /** Based on user location, cookie consent can be shown to the user if needed */
+    requiresCookieConsent: boolean;
+
+    /** TimeStamp of user registration */
+    joindate?: number;
+
+    /** TimeStamp of user last login */
+    logindate?: number;
+}
 
 /**
  * user info as it's returned from account or node users
  */
-export interface UserInfo {
-    /**
-     * true if user is authenticated
-     */
-    auth?: boolean;
-
-    /**
-     * aka userToken in storage
-     */
-    token?: string;
+export type UserInfo = {
+    /** aka userToken in storage */
+    token: string;
+} & (
+    | {
+          auth: false;
+          userInfo: {
+              requiresCookieConsent: boolean;
+          };
+      }
+    | {
+          /** true if user is authenticated */
+          auth: true;
 
-    /**
-     * @deprecated
-     * tier level of user premium - TODO remove
-     */
-    subscription?: SubTier;
+          /** @deprecated */
+          subscription?: SubTier;
 
-    /** Detail info about subscription. It is undefined if no subscription is available for the user. */
-    subscriptionInfo?: SubscriptionInfo;
+          /** Detail info about subscription. It is undefined if no subscription is available for the user. */
+          subscriptionInfo?: SubscriptionInfo;
 
-    /**
-     * user as in storage definition
-     */
-    userInfo?: User;
-}
+          /**
+           * user as in storage definition
+           */
+          userInfo: User;
+      }
+);
 
 /**
  * @typedef {Object} LoginResponse login response as it's returned from account or node login
@@ -56,3 +77,37 @@ export interface AccountLoginResponse {
      */
     authHash: string;
 }
+
+/**
+ * In order to motivate users to register/login, we show login/register popup
+ * in certain situations. This object contains
+ *
+ */
+export type LoginAndFinishAction =
+    | {
+          action: 'addFav';
+          params: FavFragment;
+      }
+    | {
+          action: 'alerts-edit';
+          params: PluginsOpenParams['alerts-edit'];
+      }
+    | {
+          action: 'uploader';
+          params: PluginsOpenParams['uploader'];
+      }
+    | {
+          action: 'favs';
+          params: PluginsOpenParams['favs'];
+      }
+    | {
+          action: 'colors';
+          params: PluginsOpenParams['colors'];
+      }
+    | {
+          action: 'openExternalPlugin';
+          params: {
+              name: ExternalPluginIdent;
+              openParams: PluginsOpenParams['windy-external-plugin'];
+          };
+      };