@windycom/plugin-devtools 3.0.0 → 3.0.1

package/README.md

@@ -4,6 +4,7 @@ Check out https://docs.windy-plugins.com for more information.
 
 # CHANGELOG
 
+-   3.0.1 - TS declarations for client v46.1.0
 -   3.0.0 - TS declarations for client v45.0.0
 -   2.0.2 - Support Windows in file path regex
 -   2.0.1 - Remove less-autoprefixer

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@windycom/plugin-devtools",
-    "version": "3.0.0",
+    "version": "3.0.1",
     "description": "Developer tools and TS declarations for developers of Windy Plugins.",
     "main": "index.mjs",
     "module": "index.mjs",

package/types/client/BottomSlide.d.ts

@@ -48,6 +48,9 @@ export declare class BottomSlide extends Drag {
     ondrag(_x: number, y: number, e: Event): void;
     ondragend(): void;
     startDrag(e: TouchEvent): void;
+    release(): void;
     private initCloseOnSwipeDown;
+    private setHalfOpen;
     private updatePosition;
+    private onRqstPluginHalfOpen;
 }

package/types/client/Color.d.ts

@@ -75,7 +75,7 @@ export declare class Color {
      * bOpaque .. set alpha to 255
      * bPremultiply .. mul RGB by A
      * valueScale .. optional scale used for WebGL texture data (coef 0.5 means half step - gradient size is doubled)
-     * return .. output Uint8Array with color data
+     * return .. output Uint8Array with color data (NOTE: Uint8ClampedArray NOT SUPPORTED in WebGL!)
      */
     createGradientArray(bOpaque?: boolean, bPremultiply?: boolean, valueScale?: number): Uint8Array;
     /**

package/types/client/EcmwfProduct.d.ts

@@ -1,29 +1,7 @@
 import { Calendar } from '@windy/Calendar';
 import { Product } from '@windy/Product';
 import type { ProductInitParams } from '@windy/Product';
-/**
- * Common product params for ECMWF products.
- */
-export declare const EcmwfProductParams: {
-    modelName: string;
-    modelResolution: number;
-    provider: string;
-    interval: number;
-    intervalPremium: number;
-    maxTileZoom: {
-        free: number;
-        premium: number;
-    };
-    dataQuality: "normal";
-};
 export declare class EcmwfProduct extends Product {
     calendar: Calendar;
     constructor(params: Partial<ProductInitParams>);
-    /**
-     * Create fake minifest file for ECMWF product to use it during rendering of
-     * UI before real minifest is loaded.
-     *
-     * DO NOT TRY TO USE THIS CALENDAR FOR FETCHING DATA FROM SERVER!!!!
-     */
-    static createVirtualCalendar(this: EcmwfProduct): Calendar;
 }

package/types/client/ExternalSveltePlugin.d.ts

@@ -22,10 +22,15 @@ export declare class ExternalSveltePlugin extends SveltePlugin<'windy-external-p
     mobileConfig: Record<InstalledExternalPluginConfig['mobileUI'], Config2config>;
     desktopConfig: Record<InstalledExternalPluginConfig['desktopUI'], Config2config>;
     widthOfRhPane: number;
+    version: string;
     listenToSingleclick: ExternalPluginConfig['listenToSingleclick'];
     addToContextmenu: ExternalPluginConfig['addToContextmenu'];
-    constructor(params: WindowPluginInitParams<'windy-external-plugin'>, { desktopUI, title, mobileUI, desktopWidth, routerPath, listenToSingleclick, addToContextmenu, url, }: InstalledExternalPluginConfig);
+    constructor(params: WindowPluginInitParams<'windy-external-plugin'>, { desktopUI, title, mobileUI, desktopWidth, routerPath, listenToSingleclick, addToContextmenu, url, version, }: InstalledExternalPluginConfig);
     open({ params, disableOpeningAnimation, qs, }: PluginOpeningOptions<'windy-external-plugin'>): Promise<void | boolean>;
+    hasNewerVersion(latestVersion: string): boolean;
+    showConfirmationWindow(): Promise<boolean>;
+    getDayDiff(timestamp: string): number;
+    uninstallPlugin(): Promise<void>;
     getCss(): string;
 }
 export {};

package/types/client/IDB.d.ts

@@ -1,8 +1,14 @@
 import type { Timestamp } from '@windy/types.d';
+/**
+ * List of all collections we will need in our database
+ * remember to update this list when adding new collections
+ * Collections MUST be created at once
+ */
+export declare const allUsedCollections: readonly ["customColors", "installedPlugins", "likedStoryComments", "log", "markedNotams", "popularLocations", "searchRecents", "seenArticles", "seenPromos", "seenStories", "slidedCapAlerts", "userAlerts", "userFavs"];
 /**
  * Allowed data types for storage
  */
-export type DatabaseStore = 'userFavs' | 'userAlerts' | 'customColors' | 'searchRecents' | 'markedNotams' | 'minifests' | 'seenArticles' | 'seenPromos';
+export type DatabaseStore = (typeof allUsedCollections)[number];
 export type BackendItem<V> = {
     updated: Timestamp;
     id: string;

package/types/client/Metric.d.ts

@@ -86,13 +86,17 @@ export declare abstract class Metric<T extends string | number = string | number
      * @param params
      */
     constructor(params: MetricInitParams);
+    /**
+     * Returns metric value
+     */
+    getMetric(): MetricItem;
     onMetricChanged(metric: MetricItem): void;
     getDefault(): MetricItem;
     setDefault(): void;
     /**
      * get value + label on a basis of user selected metric
      */
-    convertValue(value: NumValue, separator?: string, suffix?: string): string;
+    convertValue(value: NumValue, separator?: string, suffix?: string, forcedPrecision?: number): string;
     /**
      * Not available
      */

package/types/client/Overlay.d.ts

@@ -159,7 +159,7 @@ export declare class Overlay<I extends Overlays = Overlays, M extends I extends
     /**
      * Just proxy to the Metric's metric property
      */
-    get metric(): "" | import("./Metric").MetricItem;
+    get metric(): import("./Metric").MetricItem | "";
     protected initProperties(): void;
 }
 export {};

package/types/client/Plugin.d.ts

@@ -109,6 +109,10 @@ export declare class Plugin<P extends PluginIdent> {
      * Ready to be overloaded
      */
     paramsChanged(..._args: unknown[]): void;
+    /**
+     * Ready to be overloaded
+     */
+    onRenderStart(..._args: unknown[]): void;
     protected initProperties(): void;
 }
 export {};

package/types/client/Product.d.ts

@@ -192,12 +192,12 @@ export declare class Product {
      */
     hideProductSwitch?: boolean;
     constructor(params: ProductInitParams);
-    refTime(): YYYYMMDDHH | '';
+    refTime(): YYYYMMDDHH | undefined;
     getUpdateTimes(): {
         refTime: ISODateString;
         minUpdate: Timestamp;
     } | null;
-    moveTs(moveRight: boolean, isAccu?: boolean): boolean | void;
+    moveTs(moveRight: boolean, isAccu?: boolean): boolean;
     getMinifestUrl(): string;
     loadMinifest(): Promise<http.HttpPayload<MinifestObject>>;
     loadAndGetReftime(): Promise<ISODateString | undefined>;
@@ -211,14 +211,6 @@ export declare class Product {
     printLogo(): void;
     getCalendar(): Promise<Calendar>;
     protected expire(): void;
-    /**
-     * Since dissemination of minifests is not instant, and can last for minutes,
-     * we have to double check, that incoming minifest
-     * is newer than the one we have in store. If not, we keep the old one.
-     *
-     * @returns Incoming, or stored minifest, which is newer
-     */
-    protected getUpdatedMinifest(minifest: MinifestObject): Promise<MinifestObject>;
     protected setExpireTime(): void;
     /**
      * Major reason for this error is user's bad connection, which is handled

package/types/client/RadarPlusProduct.d.ts

@@ -15,5 +15,5 @@ export declare class RadarPlusProduct extends StaticProduct {
     /**
      * Handling keyboard shortcuts
      */
-    moveTs(moveRight: boolean): boolean | void;
+    moveTs(moveRight: boolean): boolean;
 }

package/types/client/SatelliteProduct.d.ts

@@ -15,5 +15,5 @@ export declare class SatelliteProduct extends StaticProduct {
     /**
      * Handling keyboard shortcuts
      */
-    moveTs(moveRight: boolean): void;
+    moveTs(moveRight: boolean): boolean;
 }

package/types/client/SveltePlugin.d.ts

@@ -2,13 +2,18 @@ import { WindowPlugin } from '@windy/WindowPlugin';
 import type { WindowPluginInitParams } from '@windy/WindowPlugin';
 import type { PluginsOpenParams, PluginsQsParams } from '@windy/plugin-params.d';
 import type { BottomSveltePlugins, SveltePanePlugins, SveltePlugins } from '@windy/plugins.d';
+import type { InterpolatorFactory } from '@windy/interpolator';
+import type { FullRenderParameters } from '@windy/Layer.d';
 export declare class SvelteApp<P extends keyof SveltePlugins | keyof SveltePanePlugins | keyof BottomSveltePlugins> {
+    interpolator?: InterpolatorFactory;
     constructor(_args: {
         target: HTMLElement;
         anchor: HTMLElement;
     });
     onopen(params?: PluginsOpenParams[P], qs?: PluginsQsParams[P]): void;
     onclose(): void;
+    paramsChanged(params?: FullRenderParameters): void;
+    onRenderStart(params?: FullRenderParameters): void;
     $destroy(): void;
 }
 /**
@@ -39,6 +44,8 @@ export declare class SveltePlugin<P extends keyof SveltePlugins | keyof SveltePa
     });
     onopen(params?: PluginsOpenParams[P], _qs?: PluginsQsParams[P]): void;
     ondestroy(): void;
+    paramsChanged(params?: FullRenderParameters): void;
+    onRenderStart: (params?: FullRenderParameters) => void;
     protected mount(): void;
     protected unmount(): void;
 }

package/types/client/WindowPlugin.d.ts

@@ -1,3 +1,4 @@
+import { BottomSlide } from '@windy/BottomSlide';
 import { Plugin } from '@windy/Plugin';
 import { Window } from '@windy/Window';
 import type { PluginInitParams } from '@windy/Plugin';
@@ -6,9 +7,8 @@ import type { PluginOpeningOptions, WindowClosingOptions } from '@windy/interfac
 import type { InterpolatorFactory } from '@windy/interpolator';
 import type { PluginsOpenParams, PluginsQsParams } from '@windy/plugin-params.d';
 import type { BottomSveltePlugins, SveltePanePlugins, SveltePlugins, TagPlugins } from '@windy/plugins.d';
-import type { ParsedQueryString } from '@windy/queryString';
 import type { ListeningPriority } from '@windy/singleclick.d';
-import type { LoadedTranslations } from '@windy/types';
+import type { LoadedTranslations, ParsedQueryString } from '@windy/types';
 export interface WindowPlugins extends TagPlugins, SveltePlugins, SveltePanePlugins, BottomSveltePlugins {
 }
 /** Allowed params to WindowPlugin constructor (private and protected props are omited by default) */
@@ -26,6 +26,7 @@ export declare abstract class WindowPlugin<P extends keyof WindowPlugins> extend
      * ID of CSS style
      */
     protected cssID: `plugin-css-${string}`;
+    protected bottomSlide?: BottomSlide;
     /**
      * Was CSS inserted into the DOM
      */

package/types/client/appsFlyer.d.ts

@@ -1,3 +1,2 @@
-import type { AppsFlyerPlugin } from 'appsflyer-capacitor-plugin/src/definitions';
-export declare const appsFlyerPromise: Promise<AppsFlyerPlugin | undefined>;
+export declare const appsFlyerPromise: Promise<undefined>;
 export declare function logAppsFlyerProductChange(): void;

package/types/client/compatibilityCheck.d.ts

@@ -0,0 +1 @@
+export {};

package/types/client/connection.d.ts

@@ -1,4 +1,4 @@
 /**
  * Connection is lost, user is offline
  */
-export declare function testNetworkConnection(): void;
+export declare function testNetworkConnection(): Promise<void>;

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

@@ -66,6 +66,7 @@ export type ColorIdent =
     | 'uvindex'
     | 'turbulence'
     | 'icing'
+    | 'dewpoint'
     | 'wetbulbtemp';
 
 type PluginColorIdent =

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

@@ -1,4 +1,4 @@
-import { Timestamp } from '@windy/types.d';
+import { Timestamp, type NumOrNull } from '@windy/types.d';
 
 type CityDivId = string; // `${x}:${y}`
 type CityLabelId = string; // `${lat}/${lon}`
@@ -18,7 +18,7 @@ export interface CityLabel {
     el: HTMLDivElement;
 
     /** Forecast data with temperature in K, it is lazy loaded with forecast request */
-    data?: number[];
+    data?: NumOrNull[];
 }
 
 /** Representation of one leaflet tile with its CityLabels */

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

@@ -20,10 +20,9 @@ export interface AlertRequest {
     priority?: number;
     suspended: boolean;
     userInterest: UserInterest;
+    hasCustomDescription?: boolean;
 }
 
-type Extends<T, U extends T> = U;
-
 export type GlobalProductWithWaves = Extends<Products, 'ecmwf' | 'gfs' | 'icon' | 'mblue'>;
 
 export interface AlertCheckResponse {

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

@@ -8,7 +8,6 @@
     TODO: Minimize amount of these events and reduce their usage
 
 */
-import { DetailLocChangeParams } from '@plugins/detail/detail.d';
 import { ParsLocation as GlobeParsLocation } from '@plugins/globe/main/receiver.d';
 import { Params as GlobeParams, Poi as GlobePoi } from '@plugins/globe/types.d';
 import { ExtendedDataAndParams } from '@plugins/isolines/IsolinesCanvas2D.d';
@@ -25,6 +24,7 @@ import type { CenterOptions } from '@windy/map';
 import type { AnimationOptions, FitBoundsOptions, LngLatBoundsLike } from '@windycom/maplibre-gl';
 import type { ViewportBounds } from '@plugins/_shared/maplibre/utils/maplibreUtils';
 import type { RadarPlusLayer } from '@plugins/radar-plus/types';
+import type { ParsedStartupValues } from './router';
 
 type BcastTypesNonGeneric = {
     /**
@@ -80,9 +80,6 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     /** Plugin was successfully closed */
     pluginOpened: [PluginIdent | string];
 
-    /** Svelte plugin was successfully mounted */
-    pluginMounted: [PluginIdent | string];
-
     /**
      * Triggered when Windy has successfully loaded and rendered requested data.
      * Use this for triggering your own tasks.
@@ -114,17 +111,26 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     alertChanged: [];
 
     /**
-     * Indicates, that router has parsed URL and launched plugin
-     * that was requested in URL
+     * Indicates, that router has parsed URL
+     */
+    routerParsed: [PluginIdent | ExternalPluginIdent | void, ParsedStartupValues | undefined];
+
+    /**
+     * Indicates that mobile ui of plugin using BottomSlide was half opened
+     */
+    pluginHalfOpened: [PluginIdent, boolean];
+
+    /**
+     * Request to half open plugin, used in BottomSlide
      */
-    routerParsed: [PluginIdent | ExternalPluginIdent | void];
+    rqstHalfOpen: [ident: PluginIdent, value: boolean | undefined, emit: boolean | undefined];
 
     // prettier-ignore
     /** @ignore */ globeOpened: [];
     /** @ignore */ globeClose: [];
     /** @ignore */ globeFailed: [];
 
-    /** @ignore */ 'globe-detail': [DetailLocChangeParams | (LatLon & PluginSource)];
+    /** @ignore */ 'globe-detail': [LatLon & PluginSource];
     /** @ignore */ 'globe-isolines': [ExtendedDataAndParams | null];
     /** @ignore */ 'globe-poi': [GlobeParsLocation & { type?: string; id?: string }];
     /** @ignore */ 'globe-zoomIn': [[number, number] | null] | [];
@@ -155,13 +161,12 @@ export interface BasicBcastTypes<T extends keyof Plugins> {
     ];
     /** @ignore */ 'radarPlus-open-layer': [RadarPlusLayer, boolean | undefined]; // Layer to open, whether to open layer for color editing
     /** @ignore */ detailClose: [];
-    /** @ignore */ detailRendered: []; // used only in embed2
+    /** @ignore */ detailRendered: []; // used only in embed, imaker indicates that detail is ready
+    /** @ignore */ stationRendered: []; // used only in embed, imaker indicates that detail is ready
     /** @ignore */ reloadFavs: [];
     /** @ignore */ notifPrefChanged: [NotificationPreferences | undefined];
     /** @ignore */ satBackupReload: [];
     /** @ignore */ promptSavePassword: [];
-    /** @ignore */ screenshotReady: [];
-    /** @ignore */ screenshotError: [Error];
     /** @ignore */ onResume: [];
     /** @ignore */ back2home: [];
     /** @ignore */ reloadMobileApp: [];

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

@@ -12,9 +12,9 @@ import {
 
 import {
     Consent,
+    DetailExtendedLatLon,
     GeolocationInfo,
     HomeLocation,
-    InstalledExternalPluginConfig,
     LatLon,
 } from '@windy/interfaces.d';
 
@@ -25,20 +25,21 @@ import {
     ShowableError,
     SubTier,
     Timestamp,
-    type Hours,
-    type RouteMotionSpeed,
-    type UsedMapLibrary,
-    type UserInterest,
+    Hours,
+    RouteMotionSpeed,
+    UsedMapLibrary,
+    UserInterest,
 } from '@windy/types.d';
 
 import { MetricItem } from '@windy/Metric.d';
 
-import type { User, LoginAndFinishAction } from '@windy/user.d';
+import type { LoginAndFinishAction, User } from '@windy/user.d';
 
 import type { SubscriptionInfo } from '@plugins/_shared/subscription-services/subscription-services.d';
 import type RadarCalendar from '@plugins/radar/calendar/RadarCalendar';
 import type SatelliteCalendar from '@plugins/satellite/calendar/SatelliteCalendar';
-import type { NumberRange } from './alerts';
+import type { NumberRange } from '@windy/alerts.d';
+import type { FavTypeNew } from '@windy/favs.d';
 
 /**
  * Custom animation particles settings
@@ -151,6 +152,11 @@ export interface DataSpecificationsObject<T> {
     asyncSet?: (...args: unknown[]) => Promise<T>;
 }
 
+export interface FeatureFlags {
+    disableSatellitePlus: boolean;
+    disableNewRadarPlusGui: boolean;
+}
+
 /**
  * # Properties used in @windy/store
  *
@@ -209,7 +215,7 @@ export interface DataSpecifications {
      * Read only value! UTC string containing time of actually rendered data that are available for current overlay and weather model.
      * @ignore
      */
-    path: DataSpecificationsObject<Path>;
+    path: DataSpecificationsObject<Path | null>;
 
     /**
      * Which type of isolines to render
@@ -281,6 +287,11 @@ export interface DataSpecifications {
      */
     latlon: DataSpecificationsObject<boolean>;
 
+    /**
+     * Display altitude on picker
+     */
+    showPickerElevation: DataSpecificationsObject<boolean>;
+
     /**
      * Desired language for Windy. By default is determined by user's browser setting and set to `auto`.
      * Use `store.getAllowed('lang')` to get list of avail langs defined in `supportedLanguages.
@@ -292,6 +303,11 @@ export interface DataSpecifications {
      */
     englishLabels: DataSpecificationsObject<boolean>;
 
+    /**
+     * Consent to receive newsletter
+     */
+    marketingConsent: DataSpecificationsObject<boolean>;
+
     /**
      * Display directions in Weather picker as number or as a string (for example NW).
      */
@@ -384,6 +400,11 @@ export interface DataSpecifications {
      */
     startUpLastOverlay: DataSpecificationsObject<boolean>;
 
+    /**
+     * User selected default zoom
+     */
+    startUpZoom: DataSpecificationsObject<number | null>;
+
     /**
      * Save forecast resolution step to be used at startup.
      * 1: 1h step
@@ -448,7 +469,7 @@ export interface DataSpecifications {
      * Detail's location - TODO: get rid of async name property
      * @ignore
      */
-    detailLocation: DataSpecificationsObject<(LatLon & { name?: string; id?: string }) | null>;
+    detailLocation: DataSpecificationsObject<DetailExtendedLatLon | null>;
 
     /**
      * 1h step of forecast
@@ -697,12 +718,6 @@ export interface DataSpecifications {
      */
     mapCoords: DataSpecificationsObject<MapCoordinates | null>;
 
-    /**
-     * Whether app has been launched from some source which requires different init state
-     * @ignore
-     */
-    launchedBy: DataSpecificationsObject<'radar-widget' | null>;
-
     /**
      * Any stored metric
      * @ignore
@@ -836,12 +851,6 @@ export interface DataSpecifications {
      */
     appLocalStorageCounter: DataSpecificationsObject<number | null>;
 
-    /**
-     * List of installed external plugins
-     * @ignore
-     */
-    installedPlugins: DataSpecificationsObject<InstalledExternalPluginConfig[]>;
-
     /*
      * User has entered into arrange mode in RH menu
      */
@@ -879,6 +888,22 @@ export interface DataSpecifications {
      * successfully sent to the backend
      */
     pushNotificationsReady: DataSpecificationsObject<boolean>;
+
+    /**
+     * Feature flags to enable/disable features without the need to re-release the client
+     */
+    featureFlags: DataSpecificationsObject<FeatureFlags>;
+
+    /**
+     * Whenever fullscreen plugin is opened on mobile device suspend potential
+     * sound & haptic feedback on radar/sat layers
+     */
+    suspendSoundAndHaptic: DataSpecificationsObject<boolean>;
+
+    /**
+     * User has enabled advanced features in debug console
+     */
+    advancedDebugConsole: DataSpecificationsObject<boolean>;
 }
 
 /**

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

@@ -11,29 +11,28 @@ export type FavType = FavTypeNew | 'alert';
 
 export type RouteAsString = `${RouteType}/${string}`;
 
-export type FavFragment =
-    | (LatLon & {
-          /** Title of the fav */
-          title: string;
-      }) &
-          (
-              | { type: 'fav' }
+export type FavFragment = (LatLon & {
+    /** Title of the fav */
+    title: string;
+}) &
+    (
+        | { type: 'fav' }
 
-              /** @deprecated use till migration of alerts is in process */
-              | {
-                    type: 'alert';
-                    alert: Alert;
-                    alertProps: AlertProps;
-                }
+        /** @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 }
+        /** Airport ICAO code in case of airport */
+        | { type: 'airport'; icao: string }
 
-              /** Weather station ID (if WX station) */
-              | { type: 'station'; stationId: StationId }
-              | { type: 'webcam'; webcamId: number }
-              | { type: 'route'; route: RouteAsString }
-          );
+        /** Weather station ID (if WX station) */
+        | { type: 'station'; stationId: StationId }
+        | { type: 'webcam'; webcamId: number }
+        | { type: 'route'; route: RouteAsString }
+    );
 
 export type Fav = FavFragment & {
     /** Unique mongoDb ID of item */

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

@@ -41,12 +41,11 @@ export interface InitOptions extends WindyAPIOptions {
     zoom?: number;
 }
 
-type ApiPicker =
-    | typeof import('@windy/picker') & {
-          open: (latLon: LatLon) => void;
-          close: () => void;
-          getParams: () => PluginsOpenParams['picker'];
-      };
+type ApiPicker = typeof import('@windy/picker') & {
+    open: (latLon: LatLon) => void;
+    close: () => void;
+    getParams: () => PluginsOpenParams['picker'];
+};
 
 export type InitCb = (windyAPI: {
     map: WModules['map']['map'];
@@ -61,7 +60,6 @@ export type InitCb = (windyAPI: {
 export interface ApiAuthResponse {
     domains: string;
     paid: boolean;
-    apiUser: string;
     id: string;
     name: string;
     type: string;