@windycom/plugin-devtools 2.0.0 → 3.0.1

package/types/interfaces.d.ts

@@ -1,41 +1,42 @@
 /**
  * Main Windy interfaces
  */
-import { ClientMessage } from '@plugins/offline/offline';
 import { Weekday } from '@windy/Calendar.d';
 import { ExtendedTileParams } from '@windy/DataTiler.d';
+import { FavId } from '@windy/favs';
 import { FullRenderParameters } from '@windy/Layer.d';
 import { Particles } from '@windy/Particles';
-import { PluginsOpenParams, type PluginsQsParams } from '@windy/plugin-params.d';
+import { PluginsOpenParams, PluginOpenEventSource, PluginsQsParams } from '@windy/plugin-params.d';
 import { Plugins } from '@windy/plugins.d';
-import { AcTimes, Isolines, Levels, Overlays, PointProducts, Products } from '@windy/rootScope.d';
+import { Isolines, Levels, Overlays, PointProducts, Products } from '@windy/rootScope.d';
 import {
-  BatteryPreferences,
-  CapAlertInfo,
-  CapAlertSeverity,
-  CapAlertType,
-  DetailDisplayType,
-  DetailRows,
-  Directions,
-  FavType,
-  GoogleServicesPreferences,
-  GpsPreferences,
-  ISODateString,
-  LocationPreferences,
-  MeteogramLayers,
-  MeteogramLevels,
-  NotificationPreferences,
-  NumOrNull,
-  NumValue,
-  Path,
-  Pixel,
-  Platform,
-  SearchType,
-  StationOrPoiType,
-  Timestamp,
-  WidgetNotificationPreferences,
-  YearMonthDay,
-  type MigrationResult,
+    BatteryPreferences,
+    CapAlertInfo,
+    CapAlertSeverity,
+    CapAlertType,
+    DetailDisplayType,
+    DetailRows,
+    Directions,
+    GoogleServicesPreferences,
+    GpsPreferences,
+    ISODateString,
+    LocationPreferences,
+    MeteogramLayers,
+    MeteogramLevels,
+    NotificationPreferences,
+    NumOrNull,
+    NumValue,
+    Path,
+    Pixel,
+    Platform,
+    Timestamp,
+    WidgetNotificationPreferences,
+    WidgetType,
+    YearMonthDay,
+    Hours,
+    Minutes,
+    SubTier,
+    CustomAppIcon,
 } from '@windy/types.d';
 
 export interface ExportedObj {
@@ -117,8 +118,8 @@ export interface GeolocationInfo extends LatLon {
  * TODO: This is basically copied favorite
  */
 export interface HomeLocation extends LatLon {
+    id: FavId;
     title: string;
-    updated?: string;
 }
 
 export interface Alert {
@@ -159,6 +160,7 @@ export interface Alert {
     snow: {
         active: boolean;
         min: number;
+        max: number;
     };
 
     /**
@@ -168,6 +170,7 @@ export interface Alert {
     rain: {
         active: boolean;
         min: number;
+        max: number;
         hours: 3 | 6 | 12 | 24 | 48;
     };
 
@@ -247,154 +250,12 @@ export interface AlertProps {
     suspended?: boolean;
 }
 
-export interface Fav extends LatLon {
-    /** Unique ID of item */
-    id: string;
-
-    /* How many times was this item hit/used */
-    counter?: number;
-
-    /** Title of item */
-    title: string;
-
-    /** @deprecated Name was used till 2019, all should be refactored to `title` if it is safe */
-    name?: string;
-
-    /** Unique invented key, for access */
-    key?: string;
-
-    /** Type of item */
-    type: FavType | SearchType;
-
-    /** Airport ICAO code in case of airport */
-    icao?: string;
-
-    /** Weather station ID (if WX station) */
-    stationId?: string;
-
-    /** Webcam ID in case of webcam */
-    webcamId?: number;
-
-    /** For saved routes */
-    route?: string;
-
-    /**
-     * If user wants to pin to top this fav, this timestamp enable us to sort all the favs
-     * so the last pinned is on top
-     */
-    pin2top?: Timestamp | null;
-
-    /**
-     * If user wants to pin to homepage this fav, this timestamp enable us to sort all the favs
-     * so the last pinned is first in line
-     */
-    pin2homepage?: Timestamp | null;
-}
-
-/** Search result payload as received from backend */
-export interface SearchResult extends Fav {
-    /** Localized Search result */
-    title: string;
-
-    /** Type of item */
-    type: SearchType;
-
-    /** Localized, human readable country name */
-    country?: string | null;
-
-    /** Lowercase ISO-2 CC */
-    cc?: string;
-
-    /** Localized, human readable region */
-    region?: string | null;
-
-    /** Localized, human readable state */
-    state?: string;
-
-    /** Stringified bounds of found item for case of island, country etc */
-    bounds?: string;
-
-    /**
-     * Added properties for purpose of recent searches
-     */
-
-    /** Creation date */
-    timestamp?: Timestamp;
-
-    /** Search query under which was item stored to recents */
-    query?: string;
-}
-
-export interface HttpSearchPayload {
-    header: {
-        type: 'search' | 'coordinates' | 'query-error' | '2airports';
-    };
-    data: SearchResult[];
-}
-
-export interface SavedFav extends Fav {
-    /** Title of item */
-    title: string;
-
-    /** Unique invented key, for access */
-    key: string;
-
-    /** Type of item */
-    type: FavType;
-
-    /** Alert settings (conditions, properties, ...) if any */
-    alert?: Alert;
-
-    /** Basic info about alert if any */
-    alertProps?: AlertProps;
-
-    /**
-     * Query params of the route needed for creating the route again
-     *
-     * @example car/50.43,21.49;48.14,20.61;49.18,21.41
-     */
-    route?: string;
-
-    /**
-     * Timestamp when the item has been updated for the last time. It is used for updating items on all devices (the most up-to-date wins)
-     */
-    updated?: Timestamp;
-
-    overflowed?: boolean;
-
-    /** @deprecated Use `title` instead. This property is presented only because of in local storage saved old favs compatibility. */
-    name?: string;
-    /** Used for alerts to open slider on active timestamp */
-    moveToTimestamp?: boolean;
-}
-
-export interface UpcomingFav extends Fav {
-    // TODO - is it necessary? Isn't just some migration deprecated stuff?
-    name?: string;
-
-    /** Type of item */
-    type: FavType;
-
-    // TODO - is it necessary? Can unsaved fav has a route property?
-    route?: string;
-
-    // TODO - is it necessary? Can unsaved fav has an alert property?
-    alert?: Alert;
-
-    // TODO - is it necessary? Can unsaved fav has an updated property?
-    updated?: Timestamp;
-}
-
-export interface SavedAlertFav extends UpcomingFav {
-    _id?: string;
-    alert: Alert;
-}
-
 export interface WeatherParameters {
+    acRange: Timestamp;
     overlay: Overlays;
-    acTime: AcTimes;
     level: Levels;
-    isolines: Isolines;
+    isolinesType: Isolines;
+    isolinesOn: boolean;
     path: Path;
     product: Products;
 }
@@ -415,6 +276,8 @@ export interface LastSentDevice {
     platform: string;
     target: string;
     version: string;
+    subscription: SubTier;
+    cc: string;
     deactivated?: boolean;
     updated?: number;
     screen?: {
@@ -459,7 +322,7 @@ export interface Celestial {
     /**
      * TZ offset in hours
      */
-    TZoffset: number;
+    TZoffset: Hours;
 
     /**
      * TZ offset nicely formatted
@@ -469,7 +332,7 @@ export interface Celestial {
     /**
      * TZ offset in minutes
      */
-    TZoffsetMin: number;
+    TZoffsetMin: Minutes;
 
     /**
      * Type of TZ type t..terrestrial, n..nautical
@@ -478,6 +341,7 @@ export interface Celestial {
 
     /**
      * Determines probability if the location is at sea or not as number from 1..0
+     * Unfortunately the number is inverted, so 1 means land, and 0 means sea
      */
     atSea: number;
 
@@ -511,7 +375,7 @@ export interface Celestial {
 /**
  * Summary day as received from backend
  */
-export interface SummaryDay {
+export interface CalendarSummaryDay {
     /**
      * Identifier of the day
      */
@@ -522,6 +386,21 @@ export interface SummaryDay {
      */
     day: number;
 
+    /**
+     * Timestamp of midnight when the segment starts
+     */
+    timestamp: Timestamp;
+
+    /**
+     * Translation string for weekday
+     */
+    weekday: Weekday;
+}
+
+/**
+ * Summary day as received from backend
+ */
+export interface SummaryDay extends CalendarSummaryDay {
     /**
      * Weather icon identifier
      */
@@ -547,16 +426,6 @@ export interface SummaryDay {
      */
     tempMin: NumValue;
 
-    /**
-     * Timestamp of midnight when the segment starts
-     */
-    timestamp: Timestamp;
-
-    /**
-     * Translation string for weekday
-     */
-    weekday: Weekday;
-
     /**
      * Mean/Average Wind force
      */
@@ -771,8 +640,8 @@ export type PickDataHashPropsByType<U, Strict = true> = Pick<
                     : never
                 : never
             : U extends DataHash[P]
-            ? P
-            : never;
+              ? P
+              : never;
     }[keyof DataHash]
 >;
 
@@ -875,7 +744,7 @@ export interface NodeForecastHeader {
     /**
      * Elevation of model grid
      */
-    modelElevation: number;
+    modelElevation?: number;
 
     /**
      * UTC offset in hours
@@ -911,88 +780,83 @@ export interface WeatherDataPayload<T extends DataHash | SummaryDataHash> {
     now?: T extends SummaryDataHash ? WeatherDataNow : never;
 }
 
-/**
- * Minimal required options for RendererWeatherTable
- */
-export interface WeatherTableRenderingOptions {
+export interface DetailExtendedLatLon extends LatLon {
     /**
-     * How to display detail
+     * Optional name of the location
      */
-    display: DetailDisplayType;
+    name?: string;
 
     /**
-     * Which rows to render
+     * id of city label that was was clicked on (if any)
      */
-    rows: DetailRows[];
+    cityLabelId?: string;
 
     /**
-     * 1h or 3h step
+     * id of surf spot that was clicked on (if any)
      */
-    step: 1 | 3;
+    surfSpotId?: string;
 
     /**
-     * Width of each table cell (in pixels)
+     * id of pg spot that was clicked on (if any)
      */
-    tdWidth: Pixel;
+    pgSpotId?: string;
 
     /**
-     * How many days to display
+     * id if tide station that was clicked on (if any)
      */
-    days: number;
+    tideStationId?: string;
 
     /**
-     * Size of weather icons
+     * Source, which led to opening the detail
      */
-    iconSize: Pixel;
+    source?: PluginOpenEventSource;
 
     /**
-     * Array of times, when Alert was triggered
+     * Indicates, that the detail was just opened
      */
-    timestamps?: null | Timestamp[];
+    externalOpen?: boolean;
 
     /**
-     * Should we display detail with Z times?
+     * Array of timestamps, that arrived from Alert notification, that should be shown
      */
-    zuluMode?: boolean;
+    timestamps?: Timestamp[] | null;
 
     /**
-     * Shoud we display 12 or 24h format
+     * Timestamp to which we should scroll detail
      */
-    is12hFormat?: boolean;
+    scrollToTimestamp?: Timestamp;
+}
 
+export type WeatherTableRenderingOptions = {
     /**
-     * Content to put in header of legend
+     * Width of table element
      */
-    legendHeaderContent?: string;
+    tdWidth: number;
 
     /**
-     * Surface sea temperature if available
+     * Should we use 12h format for time?
      */
-    sst?: number;
-}
-
-// TS cannot extend from [] syntax, just create proxy type and use it in the next line
-type DetailPluginOpenParams = PluginsOpenParams['detail'];
+    is12hFormat?: boolean;
+} & Pick<DetailParams, 'display' | 'step' | 'rows' | 'days'>;
 
 /**
  * Parameters used for displaying detail (point forecast)
  */
-export interface DetailParams extends DetailPluginOpenParams, WeatherTableRenderingOptions {
-    display: DetailDisplayType;
+export interface DetailParams extends DetailExtendedLatLon {
     /**
-     * Which kind of action led to displaying the detail
+     * Optional name of the spot
      */
-    emitter?: 'externalOpen' | 'locationChange';
+    name?: string;
 
     /**
-     * Should we display extended 10hours forecast?
+     * Type of display
      */
-    extended: boolean;
+    display: DetailDisplayType;
 
     /**
-     * Height of background canvas
+     * Should we display extended 10hours forecast?
      */
-    height?: Pixel;
+    extended: boolean;
 
     /**
      * Required point product
@@ -1001,37 +865,34 @@ export interface DetailParams extends DetailPluginOpenParams, WeatherTableRender
 
     /**
      * Required multiple point products
-     * TODO - split to more interfaces, for multimodel and others
      */
     models?: Products[];
 
-    //source: PluginOpenEventSource;
-
     /**
-     * Type of POI that was clicked to open detail or was contained in URL on page load
+     * Always incrementing synchronization number, that enables
+     * to cancel async tasks, if we will have new version of params
+     * available
      */
-    poiType?: StationOrPoiType;
+    syncCounter: number;
 
     /**
-     * POI id that was clicked to open detail or was contained in URL on page load
+     * Which rows to render
      */
-    id?: string;
+    rows: DetailRows[];
 
     /**
-     * height of temperature background canvas
+     * 1h or 3h step
      */
-    tempBgH?: Pixel;
+    step: 1 | 3;
 
     /**
-     * Always incrementing synchronization number, that enables
-     * to cancel async tasks, if we will have new version of params
-     * available
+     * How many days to display
      */
-    syncCounter: number;
+    days: number;
 }
 
 /**
- * Multimple weather models loaded by multiLoad.ts
+ * Multiple weather models loaded by multiLoad.ts
  */
 export interface MultiLoadPayload {
     model: PointProducts;
@@ -1070,27 +931,6 @@ export interface ExtendedRenderParams extends ExtendedTileParams, FullRenderPara
     speed2pixel: number;
 }
 
-/**
- * Info about articles, user has already seen
- */
-export interface SeenArticle {
-    /**
-     * Last time, the article has been displayed to the user
-     */
-    checked: 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;
-}
-
 /**
  * How good are observations by this AD or WX station?
  */
@@ -1168,23 +1008,32 @@ export interface BillingPlugin {
 export interface TimeLocal {
     weekday: Weekday;
     day: string;
-    month: string;
-    year: string;
+    month?: string;
+    year?: string;
     /** '09' */
     hour: string;
 }
 
 export interface CapAlertHeadline {
+    id: string;
     start: Timestamp;
     end: Timestamp;
     type: CapAlertType;
     severity: CapAlertSeverity;
-    headline: string;
+    headline?: string;
     event: string;
     startLocal: TimeLocal;
     endLocal: TimeLocal;
 }
 
+export interface ExtendedCapLine extends CapAlertHeadline {
+    id: string;
+    startDay: string;
+    endDay: string;
+    shortenedEvent: string;
+    color: string;
+}
+
 export interface CapAlertData extends CapAlertHeadline {
     id: string;
     ident: string;
@@ -1302,7 +1151,51 @@ export interface WindyServicePlugin {
     openBackgroundLocationSettings: () => Promise<void>;
     logError: (arg: { moduleName: string; msg: string; error?: string }) => Promise<void>;
     getId: () => Promise<{ identifier: string }>;
+    getAppsflyerCredentials: () => Promise<{ devKey: string | undefined; appId: string }>;
+    addWidget: (arg: WidgetType) => Promise<void>;
+    isGarminAppInstalled: () => Promise<{ value: boolean }>;
+    setAppIcon(arg: { iconName: CustomAppIcon }): Promise<void>;
+    getAppIcon(): Promise<{ iconName: CustomAppIcon | null }>;
+}
+
+export interface NotificationLocationInfo {
+    locationEntityId: string;
+    deviceToken: string | null;
+    isRunning: boolean;
+}
+
+export interface WindyNotificationLocationPlugin {
+    getInfo: () => Promise<NotificationLocationInfo>;
+    startUpdateService: () => Promise<NotificationLocationInfo>;
+    stopUpdateService: () => Promise<NotificationLocationInfo>;
+    // Only for testing purposes
+    getDebugLog: () => Promise<{ lastLocationUpdates: string }>;
+    useCustomLocation: (arg: LatLon) => Promise<void>;
+}
+
+export interface WindyLocalNotificationPlugin {
+    schedule: (arg: {
+        title: string;
+        subtitle: string | null;
+        body: string;
+        timeInterval: number; // in seconds
+    }) => Promise<{ id: string }>; // id of the scheduled notification
+    cancel: (arg: { id: string }) => Promise<void>;
+    cancelAll: () => Promise<void>;
+    getPending: () => Promise<{ pending: string[] }>; // array of ids of pending notifications
+    registerRetentionNotification: (arg: {
+        title: string;
+        subtitle: string | null;
+        body: string;
+        marketingId: string | null; // is used for analytics
+        deepLink: string | null; // deepLink to open when the notification is clicked
+        showAfter: number; // in seconds
+        showUntil: number; // in seconds
+    }) => Promise<{ status: 'notStarted' | 'scheduled' | 'delivered' | 'opened' | 'expired' }>; // status of the registration
+    sendTestRetentionNotification: () => Promise<{ id: string }>;
+    resetRetentionNotification: () => Promise<void>;
 }
+
 /**
  * A migration tool for transferring old Web View local storage to a new location.
  * This migration is necessary when the hostname is changed in the native Capacitor configuration.
@@ -1344,11 +1237,7 @@ export interface WindyMigrationPlugin {
     /**
      * Marks migration as completed and restart WebView from origin
      */
-    markMigrationCompleted: () => Promise<void>;
-    /**
-     * Returns migration status flag - either migrationNotPerformed or migratingData
-     */
-    getMigrationStatus: () => Promise<MigrationResult>;
+    markMigrationCompleted: (opts: { reload: boolean }) => Promise<void>;
     /**
      * Sends migration data to native layer
      */
@@ -1494,18 +1383,6 @@ export interface LocationState {
     search: string;
 }
 
-export interface WindyOfflinePlugin {
-    // startOfflineMode: () => Promise<unknown>;
-    // stopOfflineMode: () => Promise<unknown>;
-    controlReadiness: () => Promise<{ value: boolean }>;
-    // fetchOfflineData: (payload: DownloadPayload) => Promise<unknown>;
-    postMessage: (message: ClientMessage) => Promise<unknown>;
-    addListener: (
-        eventName: 'offlineMessage',
-        callback: (message: { data: string }) => void,
-    ) => void;
-}
-
 /**
  * # Plugin configuration
  *
@@ -1765,3 +1642,68 @@ interface ClientPatch {
     exclusivePromos: PromoObj[];
     otherPromos: PromoObj[];
 }
+
+/**
+ * Amount of active hurricanes as returnd from hurricane tracker backend
+ */
+export interface ActiveStormCountPayload {
+    activeStormCount: number;
+}
+
+/**
+ * Cap alert was slided from left to right on startup screen
+ */
+export interface CapAlertSlided {
+    id: string;
+    expire: Timestamp;
+}
+
+/**
+ * Handy payload or reusable data that helps to render Forecast Table
+ */
+export interface WeatherTableRenderingData {
+    /**
+     * Day identifiers, that were used in data object (above)
+     */
+    usedDays: YearMonthDay[];
+
+    /**
+     * Loaded data.data (modified later by splicing data arrays)
+     */
+    data: DataHash;
+
+    /**
+     * Length of used forecast as a umber of TD segments
+     */
+    dataLength: number;
+
+    /**
+     * Start of timeline
+     */
+    start: Timestamp;
+    end: Timestamp;
+
+    tsWidth: Timestamp;
+    pxWidth: Pixel;
+    px2ts: number;
+
+    /**
+     * UTC offset in hours
+     */
+    utcOffset: Hours;
+
+    /**
+     * UTC offset in minutes
+     */
+    utcOffsetMinutes: Minutes;
+
+    /**
+     * Indicates that data payload has waves
+     */
+    hasWaves: boolean;
+
+    /**
+     * Summary of days used
+     */
+    summary: Record<YearMonthDay, SummaryDay>;
+}