@windycom/plugin-devtools 1.0.9 → 2.0.0

package/types/interfaces.d.ts

@@ -1,50 +1,42 @@
 /**
  * Main Windy interfaces
  */
+import { ClientMessage } from '@plugins/offline/offline';
 import { Weekday } from '@windy/Calendar.d';
 import { ExtendedTileParams } from '@windy/DataTiler.d';
 import { FullRenderParameters } from '@windy/Layer.d';
 import { Particles } from '@windy/Particles';
 import { PluginsOpenParams, type PluginsQsParams } from '@windy/plugin-params.d';
 import { Plugins } from '@windy/plugins.d';
+import { AcTimes, Isolines, Levels, Overlays, PointProducts, Products } from '@windy/rootScope.d';
 import {
-    AcTimes,
-    Isolines,
-    Levels,
-    Overlays,
-    PointProducts,
-    Products,
-    SupportedLanguages,
-} from '@windy/rootScope.d';
-import {
-    BatteryPreferences,
-    CapAlertInfo,
-    CapAlertSeverity,
-    CapAlertType,
-    DetailDisplayType,
-    DetailRows,
-    Directions,
-    FavType,
-    GoogleServicesPreferences,
-    GpsPreferences,
-    HTMLString,
-    ISODateString,
-    LocationPrefecernces,
-    MeteogramLayers,
-    MeteogramLevels,
-    NoticicationPrefecernces,
-    NumOrNull,
-    NumValue,
-    Path,
-    Pixel,
-    Platform,
-    SearchType,
-    StationOrPoiType,
-    Timestamp,
-    WidgetNotificationPreferences,
-    YearMonthDay,
+  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,
 } from '@windy/types.d';
-import { ClientMessage } from '@plugins/offline/offline';
 
 export interface ExportedObj {
     default?: unknown;
@@ -265,7 +257,7 @@ export interface Fav extends LatLon {
     /** Title of item */
     title: string;
 
-    /** OBSOLETE DEPRACATED. Name was used till 2019, all should be refactored to `title` if it is safe */
+    /** @deprecated Name was used till 2019, all should be refactored to `title` if it is safe */
     name?: string;
 
     /** Unique invented key, for access */
@@ -285,6 +277,18 @@ export interface Fav extends LatLon {
 
     /** 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 */
@@ -358,7 +362,7 @@ export interface SavedFav extends Fav {
 
     overflowed?: boolean;
 
-    /** DEPRACATED !!! Use `title` instead. This property is presented only because of in localstorage saved old favs compatibility. */
+    /** @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;
@@ -430,7 +434,7 @@ export interface Bounds {
 }
 
 /**
- * Leflet's tilePoint
+ * Leaflet's tilePoint
  */
 export interface TilePoint {
     x: number;
@@ -448,7 +452,7 @@ export interface Celestial {
     TZabbrev: string;
 
     /**
-     * Time zone name (for instance 'Europe/Luxemburg)
+     * Time zone name (for instance 'Europe/Luxembourg)
      */
     TZname: string;
 
@@ -468,12 +472,12 @@ export interface Celestial {
     TZoffsetMin: number;
 
     /**
-     * Type of TZ type t..terrestial, n..nautical
+     * Type of TZ type t..terrestrial, n..nautical
      */
     TZtype: 't' | 'n';
 
     /**
-     * Determines propability if the location is at sea or not as number from 1..0
+     * Determines probability if the location is at sea or not as number from 1..0
      */
     atSea: number;
 
@@ -494,7 +498,7 @@ export interface Celestial {
     night: ISODateString;
 
     /**
-     * Monet when, the data object was creted (for check of being obsolete)
+     * Monet when, the data object was created (for check of being obsolete)
      */
     nowObserved: ISODateString;
 
@@ -514,19 +518,14 @@ export interface SummaryDay {
     date: YearMonthDay;
 
     /**
-     * Day of the molnth (starting with 1)
+     * Day of the month (starting with 1)
      */
     day: number;
 
-    /**
-     * Weather icon identifier (legacy version)
-     */
-    icon: number;
-
     /**
      * Weather icon identifier
      */
-    icon2: number;
+    icon: number;
 
     /**
      * At which index, in the data table, the day starts
@@ -569,9 +568,15 @@ export interface SummaryDay {
     windDir: NumValue;
 
     /**
-     * CAP Alert warning identifier as teo letter designstor
+     * CAP Alert warning identifier as two letter designator
      */
     warning?: string;
+
+    /**
+     * Indicates that these data are fake, just for purpose to
+     * show non-premium users how the extended fcst looks like
+     */
+    isFake?: boolean;
 }
 
 /**
@@ -584,7 +589,7 @@ export interface SummaryDataHash {
     mm: NumValue[];
 
     /**
-     * Is the preciptitaion in a form fo snow?
+     * Is the precipitation in a form fo snow?
      */
     snow: (1 | 0)[];
 
@@ -636,31 +641,16 @@ export interface DataHash extends SummaryDataHash, IsDay {
      */
     hour: number[];
 
-    /**
-     * Weather icon identifier (legacy version)
-     */
-    icon: number[];
-
     /**
      * Weather icon identifier
      */
-    icon2: number[];
+    icon: number[];
 
     /**
      * Moon phase icon identifier
      */
     moonPhase: number[];
 
-    /**
-     * Date of segment beggining
-     */
-    origDate: ISODateString[];
-
-    /**
-     * TS of segment beggining (seems same as ts)
-     */
-    origTs: Timestamp[];
-
     /**
      * ?????
      */
@@ -756,6 +746,11 @@ export interface DataHash extends SummaryDataHash, IsDay {
 
     turbulence?: NumValue[];
     icing?: NumValue[];
+
+    /**
+     * Indicates, that these data are fake, just for purpose to show non-premium users how the extended fcst looks like
+     */
+    isFake?: boolean[];
 }
 
 /**
@@ -763,7 +758,7 @@ export interface DataHash extends SummaryDataHash, IsDay {
  * Strict means the extension has to be from both sides.
  *
  * @example
- * PickDataHashPropsByType<string[]> = { date: ..., origDate: ..., weathercode: ... };
+ * PickDataHashPropsByType<string[]> = { date: ..., weathercode: ... };
  * PickDataHashPropsByType<string, false> even with `warnings`, because the could be undefined and undefined does not extend number[]
  */
 export type PickDataHashPropsByType<U, Strict = true> = Pick<
@@ -808,7 +803,7 @@ export interface NodeForecastHeader {
     /**
      * Number of available days in forecast
      */
-    daysAvail?: number;
+    daysAvail: number;
 
     /**
      * Served model
@@ -893,6 +888,18 @@ export interface NodeForecastHeader {
     sst?: number;
 }
 
+/**
+ * Forecasted weather data for NOW
+ */
+
+export interface WeatherDataNow {
+    icon: number;
+    temp: NumValue;
+    wind: NumValue;
+    windDir: NumValue;
+    moonPhase: NumValue;
+}
+
 /**
  * Weather data or Summary Weather data JSON as received from node-forecast
  */
@@ -901,19 +908,11 @@ export interface WeatherDataPayload<T extends DataHash | SummaryDataHash> {
     celestial: Celestial;
     summary: Record<YearMonthDay, SummaryDay>;
     data: T;
-    now?: T extends SummaryDataHash
-        ? {
-              icon: number;
-              temp: NumValue;
-              wind: NumValue;
-              windDir: NumValue;
-              moonPhase: NumValue;
-          }
-        : never;
+    now?: T extends SummaryDataHash ? WeatherDataNow : never;
 }
 
 /**
- * Minimsl rqrd options for RendererWeatherTable
+ * Minimal required options for RendererWeatherTable
  */
 export interface WeatherTableRenderingOptions {
     /**
@@ -976,7 +975,7 @@ export interface WeatherTableRenderingOptions {
 type DetailPluginOpenParams = PluginsOpenParams['detail'];
 
 /**
- * Parametrs used for displaying detail (poinr forecast)
+ * Parameters used for displaying detail (point forecast)
  */
 export interface DetailParams extends DetailPluginOpenParams, WeatherTableRenderingOptions {
     display: DetailDisplayType;
@@ -1019,12 +1018,12 @@ export interface DetailParams extends DetailPluginOpenParams, WeatherTableRender
     id?: string;
 
     /**
-     * height of temperature bacground canvas
+     * height of temperature background canvas
      */
     tempBgH?: Pixel;
 
     /**
-     * Always incrementing synchornization number, that enables
+     * Always incrementing synchronization number, that enables
      * to cancel async tasks, if we will have new version of params
      * available
      */
@@ -1053,7 +1052,7 @@ export interface MeteogramDataPayload {
 }
 
 /**
- * Particle animation paramters
+ * Particle animation parameters
  */
 export interface ExtendedRenderParams extends ExtendedTileParams, FullRenderParameters {
     canvas: HTMLCanvasElement;
@@ -1075,9 +1074,21 @@ export interface ExtendedRenderParams extends ExtendedTileParams, FullRenderPara
  * Info about articles, user has already seen
  */
 export interface SeenArticle {
-    seen: Timestamp;
+    /**
+     * 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;
 }
 
 /**
@@ -1090,102 +1101,6 @@ export interface ObservationInfo {
     records: number;
 }
 
-export type ArticleImportances =
-    | 'extreme'
-    | 'severe'
-    | 'moderate'
-    | 'windyAnnounce'
-    | 'forecast'
-    | 'windyTutorial'
-    | 'educational'
-    | 'timeKilling'
-    | 'warning';
-
-export interface ArticleAuthor {
-    avatar: string;
-    profile: string;
-    reputation: number;
-    username: string;
-    userslug: string;
-}
-
-/**
- * This format is used backend payload for info on HP
- */
-export interface ArticleJson {
-    author: ArticleAuthor;
-    coverPhoto: {
-        desc: '' | string;
-        link: '' | string;
-        photo: '' | string;
-        showArticleCover: boolean;
-        src: string;
-    };
-    id: number;
-    importance: ArticleImportances;
-    language: SupportedLanguages;
-    ranking: number;
-    slug: string;
-    subtitle: '' | string;
-    title: string;
-    updated: ISODateString;
-
-    /**
-     * Monkey patched props
-     */
-    count: number;
-    checked: Timestamp | 0;
-    key: string;
-}
-
-/**
- * This format is used backend payload for list of articles
- */
-export interface ExtendedArticleJson extends ArticleJson {
-    countries: string | string[] | '';
-    licence: 'cc-by' | 'proprietary';
-    originalAuthor: {
-        name: string | '';
-        link: string | '';
-    };
-    perex: string | '';
-    platform: 'all' | 'ios' | 'android';
-    target: 'all' | 'index' | 'mobile';
-    device: 'all' | 'desktop' | 'mobile';
-    pid: number;
-    published: ISODateString;
-    expire: string;
-    publishedBy: number;
-    tags: string[];
-    expiration: ISODateString;
-    homepage: boolean;
-    type?: 'article' | 'video';
-}
-
-/**
- * This format is used backend payload for particular article in article list
- */
-export interface Article extends ExtendedArticleJson {
-    status: 'published' | 'unpublished' | 'expired';
-    upvotes: number;
-    viewcount: number;
-    internalUrl: {
-        url: string;
-        search: string;
-        path: string;
-        internal: boolean;
-    }[];
-    containsTwitter: boolean;
-    video?: string;
-    articleCoverPhoto: {
-        src: string;
-        photo: string;
-        desc: string;
-        link: string;
-    };
-    content: HTMLString;
-    version: string;
-}
 export interface ServiceGeoipResponse {
     country: string;
     region: `${number}`;
@@ -1198,7 +1113,7 @@ export interface ServiceGeoipResponse {
     ip: string;
 
     /**
-     * Deprecated
+     * @deprecated
      */
     hash: 'oiurouoweruouoiuou';
 }
@@ -1348,7 +1263,7 @@ export interface IsAppleWatchPairedResult {
     value: boolean;
 }
 
-export interface IsAppleWatchCompanionAppIntalledResult {
+export interface IsAppleWatchCompanionAppInstalledResult {
     value: boolean;
 }
 
@@ -1368,14 +1283,14 @@ export interface WindyWatchPlugin {
      * Watch conditions for the alert
      */
     isPaired: () => Promise<IsAppleWatchPairedResult>;
-    isWatchAppInstalled: () => Promise<IsAppleWatchCompanionAppIntalledResult>;
+    isWatchAppInstalled: () => Promise<IsAppleWatchCompanionAppInstalledResult>;
     addWatchFace: () => Promise<unknown>;
 }
 
 export interface WindyServicePlugin {
     openSettings: () => Promise<void | string>;
-    getLocationPermnissions: () => Promise<LocationPrefecernces>;
-    getNotificationPermnissions: () => Promise<NoticicationPrefecernces>;
+    getLocationPermissions: () => Promise<LocationPreferences>;
+    getNotificationPermissions: () => Promise<NotificationPreferences>;
     openApplicationSettings: () => Promise<void | string>;
     isGpsEnabled: () => Promise<GpsPreferences>;
     getBatteryUsagePermissions: () => Promise<BatteryPreferences>;
@@ -1385,6 +1300,8 @@ export interface WindyServicePlugin {
     openWidgetNotificationSettings: () => Promise<void>;
     getBackgroundLocationPermission: () => Promise<GpsPreferences>;
     openBackgroundLocationSettings: () => Promise<void>;
+    logError: (arg: { moduleName: string; msg: string; error?: string }) => Promise<void>;
+    getId: () => Promise<{ identifier: string }>;
 }
 /**
  * A migration tool for transferring old Web View local storage to a new location.
@@ -1428,6 +1345,18 @@ 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>;
+    /**
+     * Sends migration data to native layer
+     */
+    setMigrationData: (opts: { data: string }) => Promise<void>;
+    /**
+     * Returns old localStorage data (sent to native layer via setMigrationData function)
+     */
+    getOldLocalStorageDataAndroid: () => Promise<{ result: string | null }>;
 }
 
 export interface SocialLoginParams {
@@ -1458,25 +1387,12 @@ export interface ObservationSummaryRecord {
 
 export type ObservationSummaryHash = Record<YearMonthDay, ObservationSummaryRecord>;
 
-/**
- * Observation Weather data used in station plugin (so far IMHO used only to render mobile fragment)
- */
-export interface ObservationFragmentHash {
-    summary: ObservationSummaryHash;
-    data: {
-        temp: NumOrNull[];
-        wind: NumOrNull[];
-        mm: NumOrNull[];
-        snow: NumOrNull[];
-    };
-}
-
 /**
  * Opening options for Window class
  */
 export interface WindowOpeningOptions {
     /**
-     * Should we open the widnow without animation?
+     * Should we open the window without animation?
      */
     disableOpeningAnimation?: boolean;
 }
@@ -1735,6 +1651,12 @@ export interface ExternalPluginConfig {
      * space on the bottom of the screen.
      */
     mobileUI: 'fullscreen' | 'small';
+
+    /**
+     * The plugin has NO LINK in the main menu, can be open only programmatically
+     * and its installation is not persistent.
+     */
+    internal?: boolean;
 }
 
 export interface CompiledExternalPluginConfig extends ExternalPluginConfig {
@@ -1765,17 +1687,81 @@ export interface CompiledExternalPluginConfig extends ExternalPluginConfig {
  */
 export interface InstalledExternalPluginConfig extends CompiledExternalPluginConfig {
     /**
-     * URL of the plguin is used as unique identifier
+     * URL of the plugin is used as unique identifier
      */
     url: string;
 
     /**
      * From which process was plugin installed
      */
-    installedBy: 'dev' | 'gallery' | 'url';
+    installedBy: 'dev' | 'gallery' | 'url' | 'patch';
 
     /**
      * When was this plugin installed by specific user
      */
     installed: Timestamp;
 }
+
+interface PromoFilteringParams {
+    isLoggedIn: boolean;
+    sessionCounter: number;
+    isPremium: boolean;
+}
+
+/**
+ * Main promo object, used in `client-patch`
+ */
+interface PromoObj {
+    /**
+     * Main ID of the promo. This key is also used in `promo` object in localStorage
+     */
+    readonly id: string;
+
+    /**
+     * ISO date, when the promo expires
+     */
+    readonly end: string;
+
+    /**
+     * How many times display promo to the user (respective on one device)
+     */
+    counter: number;
+
+    /**
+     * How often to display promo on particular device (in ms)
+     */
+    delay: number;
+
+    /**
+     * Any others filters, deciding whether to display promo or not
+     */
+    filter: () => boolean;
+
+    /**
+     * Should we display HP articles together with promo
+     * @deprecated
+     */
+    loadArticles?: boolean;
+
+    /**
+     * Required method to be run, when promo is executed. In this stage we can also
+     * do some additional checks, if promo should be displayed or not, so we must
+     * call `promo.hitCounter()` method ourselves.
+     */
+    readonly run: () => void;
+
+    /**
+     * Optional HTML code to be used internally in `run` method
+     */
+    html?: string;
+}
+
+/**
+ * Client patch object
+ */
+interface ClientPatch {
+    __version: string;
+    __css: string;
+    exclusivePromos: PromoObj[];
+    otherPromos: PromoObj[];
+}