@windycom/plugin-devtools 2.0.0 → 3.0.1

package/types/offline.d.ts

@@ -0,0 +1,100 @@
+import type { Timestamp } from '@windy/types.d';
+
+/**
+ * Types of data that can be downloaded (for purpose of storage management)
+ */
+export type StorageDataType = 'criticalFiles' | 'images' | 'clientFiles' | 'forecastData';
+
+export type Client2ServiceWorkerMessage = 'download' | 'ping' | 'cancel' | 'goOffline' | 'goOnline';
+
+export type ServiceWorkerStatus = 'idle' | 'downloading' | 'offlineMode';
+
+export type ServiceWorker2ClientMessage =
+    | ServiceWorkerStatus
+    | 'progress'
+    | 'finished'
+    | 'error'
+    | 'cancelled'
+    | 'readyForOfflineMode'
+    | 'goingOnline';
+
+export interface ServiceWorkerMessage extends Event {
+    data: {
+        type: ServiceWorker2ClientMessage;
+        error?: string;
+        downloadedInfo?: DownloadedInfo | void;
+        expires?: Timestamp;
+    };
+}
+
+export interface ClientMessage {
+    type: Client2ServiceWorkerMessage;
+    payload?: DownloadPayload;
+}
+
+export interface FileInfo {
+    /**
+     * Mangled or hash encoded URL, as sent to the backend
+     */
+    url: string;
+
+    /**
+     * Original pure URL
+     */
+    originalUrl: string;
+}
+
+/**
+ * Request to download files from service worker
+ */
+export interface DownloadBatch {
+    type: StorageDataType;
+
+    /**
+     * Should we delete all files in this cache before downloading?
+     */
+    deleteCache: boolean;
+
+    /**
+     * Files to download
+     */
+    files: FileInfo[];
+
+    /**
+     * Given URL's are not static, but rather backend generated API calls
+     */
+    apiRqst?: boolean;
+
+    /**
+     * serviceWorker tries twice (with CORS and no-CORS) to download files
+     */
+    tryTwice2DownloadFiles?: boolean;
+}
+
+export type ErrorsByType = Record<string, number>;
+
+export interface DownloadPayload {
+    assets: string;
+    acceptHeader: string;
+    numberOfFiles: number;
+    batches: DownloadBatch[];
+    mainEntryPoint: string;
+}
+
+export interface DownloadedInfo {
+    assets: string;
+    errors: number;
+    errorsByType: ErrorsByType;
+    downloaded: Timestamp;
+    downloadeAsDate: string;
+    mainEntryPoint: string;
+}
+
+export interface DownloadProgress {
+    type: 'progress' | 'finished' | 'error';
+    downloadedFiles: number;
+    numberOfFiles: number;
+    errors: number;
+    errorUrls: string[];
+    errorsByType: ErrorsByType;
+}

package/types/types.d.ts

@@ -1,5 +1,7 @@
+import { MainLangFile, PluginTranslations } from '@windy/lang-files.d';
+
 import weatherTable from '@plugins/_shared/detail-render/weatherTable';
-import { WeatherParameters, LatLon } from './interfaces.d';
+import { LatLon, WeatherParameters } from './interfaces.d';
 
 export * from '@windy/interpolatorTypes.d';
 
@@ -18,6 +20,11 @@ export type Timestamp = number;
  */
 export type Path = string;
 
+/**
+ * String in a form YYYYMMDDHH
+ */
+export type YYYYMMDDHH = string;
+
 /**
  * Valid subscription tiers
  */
@@ -27,27 +34,10 @@ export type Platform = 'android' | 'ios' | 'desktop';
 
 export type Device = 'mobile' | 'tablet' | 'desktop';
 
-export type FavType = 'alert' | 'airport' | 'station' | 'fav' | 'webcam' | 'route';
-
-/**
- * Search item types as received from backend
- * There is more search types as received from backend (basically all OSM types)
- */
-export type SearchType =
-    | FavType
-    | 'natural'
-    | 'tourism'
-    | 'amenity'
-    | 'admin'
-    | 'highway'
-    | 'railway';
-
 export type DetailDisplayType = 'table' | 'meteogram' | 'airgram' | 'waves' | 'wind';
 
 export type Directions = 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW';
 
-export type AlertConditionProps = 'wind' | 'swell' | 'snow' | 'rain' | 'temp' | 'time' | 'model';
-
 export type HTMLElementWithSlider = HTMLElement & { noUiSlider?: noUiSlider.noUiSlider };
 
 /**
@@ -113,9 +103,10 @@ export type SveltePluginIdent = `@plugins/${keyof import('@windy/plugins.d').Sve
 export type SveltePanePluginIdent =
     `@plugins/${keyof import('@windy/plugins.d').SveltePanePlugins}`;
 
-export type TagPluginIdent = `@plugins/${keyof import('@windy/plugins.d').TagPlugins}`;
+export type BottomSveltePluginIdent =
+    `@plugins/${keyof import('@windy/plugins.d').BottomSveltePlugins}`;
 
-export type BottomTagPluginIdent = `@plugins/${keyof import('@windy/plugins.d').BottomTagPlugins}`;
+export type TagPluginIdent = `@plugins/${keyof import('@windy/plugins.d').TagPlugins}`;
 
 export type PlainPluginIdent = `@plugins/${keyof import('@windy/plugins.d').PlainPlugins}`;
 
@@ -139,12 +130,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 **/
@@ -181,7 +171,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 = {
@@ -204,6 +201,10 @@ export type GoogleServicesPreferences = {
     status: 'denied' | 'authorized';
 };
 
+export type WidgetType = {
+    widget_type: 'satellite' | 'radar' | 'webcam' | 'detail' | 'days';
+};
+
 export type ErrorCategory = 'location' | 'notification' | 'iCloud' | 'battery';
 
 export type ShowableError = {
@@ -224,10 +225,6 @@ export type ShowableErrors = {
     closed: Set<string>;
 };
 
-export type MigrationResult = {
-    status: 'migrationNotPerformed' | 'migratingData';
-};
-
 /**
  * Overlay categories used for better UI navigation (mobile/tablet)
  */
@@ -279,12 +276,26 @@ export type LogPaths =
     | 'promo'
     | 'airport'
     | 'appRating'
+    | 'appOpening'
     | 'articles'
     | 'detail2'
+    | 'appsflyer'
     | 'onboarding'
     | 'station'
     | 'weather'
-    | 'events';
+    | 'events'
+    | 'locationPermissionPopup'
+    | 'widgetPromo'
+    | 'storyEvent'
+    | 'garmin';
+
+export type LogEvents =
+    | 'logout'
+    | 'animation-started'
+    | 'user-logged'
+    | 'click-on-hp'
+    | 'article-event'
+    | 'displayed-on-hp';
 
 /**
  * Type of user consent
@@ -301,21 +312,29 @@ export type ProductIdent =
     | 'icon-d2'
     | 'arome'
     | 'arome-antilles'
+    | 'arome-france'
     | 'arome-reunion'
     | 'can-hrdps'
     | 'can-rdwps'
     | 'cams-global'
     | 'cams-eu'
+    | 'cze-aladin'
     | 'icon-global'
     | 'icon-gwam'
     | 'icon-ewam'
     | 'hrrr-alaska'
     | 'hrrr-conus'
     | 'bom-access'
+    | 'bom-access-c-ad'
+    | 'bom-access-c-bn'
+    | 'bom-access-c-dn'
+    | 'bom-access-c-nq'
+    | 'bom-access-c-ph'
+    | 'bom-access-c-sy'
+    | 'bom-access-c-vt'
     | 'ukv'
     | 'gfs'
     | 'gfs-wave'
-    | 'ecmwf-aifs'
     | 'ecmwf-hres'
     | 'ecmwf-wam'
     | 'ecmwf-efi'
@@ -331,7 +350,7 @@ export type PickerOpener = LatLon & { id: string };
 
 export type ExternalPluginIdent = `windy-plugin-${string}`;
 
-export type DropDownValues = { key: string | number; value: string | number }[];
+export type DropDownValues = { key: string | number | null; value: string | number }[];
 
 /*
  * Plugin for creating backups of Local storage
@@ -344,6 +363,7 @@ export type WindyBackupPluginInfo = {
     lastBackupTriggered: number;
     triggerCounter: number;
     deviceID: string;
+    vendorID?: string;
 };
 export interface WindyBackupPlugin {
     // Compare client counter and if is older (most likely zero, when cleared)
@@ -360,3 +380,57 @@ export interface WindyBackupPlugin {
     // Returns info about native backup
     backupInfo: () => Promise<WindyBackupPluginInfo>;
 }
+
+/**
+ * Currently used main map library
+ */
+export type UsedMapLibrary = 'leaflet' | 'maplibre' | 'globe';
+
+/**
+ * Time defined in hours
+ */
+export type Hours = number;
+
+export type Minutes = number;
+
+/**
+ * All defined translation keys
+ *
+ * WARNING: Given lang files MUST be lazy loded before using the key
+ */
+export type LoadedTranslations = MainLangFile & PluginTranslations;
+
+export type UserInterest =
+    | 'outdoor_activities'
+    | 'water_sports'
+    | 'winter_sports'
+    | 'wind_sports'
+    | 'aviation'
+    | 'boating'
+    | 'agriculture'
+    | 'meteorologist'
+    | 'other';
+
+export type ParsedQueryString = Record<string, string | undefined>;
+
+export type Size = 'xxs' | 'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl' | 'xxxl' | 'ultra';
+
+/**
+ * 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';

package/types/client/Bar.d.ts

@@ -1,114 +0,0 @@
-/**
- * @class Bar
- * Horizontal ProgressBar Class binded to stores's `timestamp`
- * @example
- *
- *    new Bar({
- *        progressLine: _.$(...)    // el to catch mouseevents
- *    })
- */
-import { Drag } from '@windy/Drag';
-import { GhostBox } from '@windy/GhostBox';
-import type { Calendar } from '@windy/Calendar';
-import type { Timestamp } from '@windy/types';
-export type BarInitParams = {
-    progressBar: HTMLDivElement;
-    offset?: number;
-    borderOffset?: number;
-    jumpingGhost?: boolean;
-    bcastLimit?: number;
-    jumpingWidth?: number;
-    resizableEl?: HTMLElement;
-};
-export declare class Bar {
-    protected drag: Drag;
-    protected ghostBox?: GhostBox;
-    /**
-     * EL of wrapping element,
-     */
-    private progressBar;
-    /**
-     * A progress line to be used in GhostBox. We need to make a copy here for mobile where
-     * the GhostBox is not present.
-     */
-    private progressLine;
-    /**
-     * Offset from left side of begginging of pb
-     */
-    private offset;
-    /**
-     * offset of pb from border of a screen
-     */
-    private borderOffset;
-    /**
-     * How often bcast dragging
-     */
-    private bcastLimit;
-    /**
-     * Width of main box fo ghost jumping
-     */
-    protected jumpingWidth: number;
-    private maxWidth;
-    private pxRatio;
-    private timecode;
-    private nowMark?;
-    private played?;
-    private ghostTxt?;
-    private throttledBcast;
-    protected progressWidth: number;
-    protected calendar: Calendar | null;
-    protected left: number;
-    protected calendarHours: number;
-    protected timestamp: Timestamp;
-    protected text: HTMLDivElement;
-    protected resizableEl: HTMLElement;
-    /**
-     * Should ghost box jump over timebox?
-     */
-    jumpingGhost: boolean;
-    constructor(params: BarInitParams);
-    /**
-     * creates text in the timeBox on a basis of
-     * relative position on a progressBar
-     */
-    protected createText(_el: HTMLDivElement): string;
-    protected pos2ts(pos: number): number;
-    protected createGhostText(_left: number): string;
-    protected setTimestamp(ts: number): void;
-    /**
-     * Time box change its position
-     */
-    protected update(newPos: number): number;
-    /**
-     * Call recalculate && setIndex
-     */
-    protected onresize(): void;
-    /**
-     * Click on progress bar
-     */
-    protected click(event: MouseEvent): void;
-    /**
-     * Sets timestamp
-     * noAnimation ... do not do CSS animation
-     */
-    protected set(timestamp: Timestamp): void;
-    protected onbcast(): void;
-    protected ondragstart(_startXY: [number, number]): void;
-    protected ondragend(_e: MouseEvent | TouchEvent): void;
-    /**
-     * Main timebox
-     */
-    private ondrag;
-    /**
-     * Updates timestamp and broadcasts it out
-     */
-    private bcast;
-    private addAnimation;
-    private removeAnimation;
-    /**
-     * Position based on ts
-     */
-    private ts2pos;
-    private updateBarFreeRange;
-    private updateGhost;
-}

package/types/client/BindedBar.d.ts

@@ -1,51 +0,0 @@
-import { Bar } from '@windy/Bar';
-import type { BarInitParams } from '@windy/Bar';
-import type { Calendar } from '@windy/Calendar';
-import type { PickDataSpecificationPropsByType } from '@windy/dataSpecifications.d';
-import type { TimeFormatFunction } from '@windy/format.d';
-import type { Timestamp } from '@windy/types.d';
-export type BindedBarInitParams = {
-    UIident: string;
-    bindTimestamp: keyof PickDataSpecificationPropsByType<Timestamp>;
-    bindCalendar: keyof PickDataSpecificationPropsByType<Calendar, false>;
-    bindAnimation: keyof PickDataSpecificationPropsByType<boolean>;
-} & BarInitParams;
-export declare class BindedBar extends Bar {
-    /**
-     * To prevent cycling
-     */
-    protected UIident: string;
-    /**
-     * Value to be binded as timetamp
-     */
-    protected bindTimestamp: keyof PickDataSpecificationPropsByType<Timestamp>;
-    /**
-     * Value to be binded as calendar
-     */
-    private bindCalendar;
-    /**
-     * Value binded with animation true/false
-     */
-    private bindAnimation;
-    protected displayHour: TimeFormatFunction;
-    protected zuluMode: boolean;
-    protected numberOfHours: number;
-    constructor(params: BindedBarInitParams);
-    unmount(): void;
-    protected onbcast(): void;
-    protected stopAnim(): void;
-    protected ondragstart(_startXY: [number, number]): void;
-    /**
-     * Click on progress bar -> stop animation
-     * @param event
-     */
-    protected click(event: MouseEvent): void;
-    /**
-     * Initialization of progressBar after changing of product etc.
-     * @param calendar
-     * @returns
-     */
-    protected setCal(calendar: Calendar | null): void;
-    private render;
-    private ontstamp;
-}

package/types/client/BindedCheckbox.d.ts

@@ -1,30 +0,0 @@
-import type { DataSpecifications } from '@windy/dataSpecifications.d';
-type BindedCheckboxInitParams<T extends keyof DataSpecifications> = {
-    el: HTMLElement;
-    bindStore: T;
-    onValue?: DataSpecifications[T]['def'];
-    offValue?: DataSpecifications[T]['def'];
-};
-export declare class BindedCheckbox<T extends keyof DataSpecifications> {
-    /**
-     * Element in DOM
-     */
-    private el;
-    /**
-     * Store item binded to this DOM el
-     */
-    private bindStore;
-    /**
-     * What kind of value is considered ON in the store
-     */
-    private onValue;
-    /**
-     * What kind of value is considered OFF in the store
-     */
-    private offValue;
-    constructor(params: BindedCheckboxInitParams<T>);
-    unmount(): void;
-    toggle(): void;
-    private set;
-}
-export {};

package/types/client/BindedSwitch.d.ts

@@ -1,35 +0,0 @@
-import { Switch } from '@windy/Switch';
-import type { DataSpecifications } from '@windy/dataSpecifications.d';
-import type { SwitchInitParams } from '@windy/Switch';
-export type BindedSwitchInitParams<T extends keyof DataSpecifications> = {
-    bindStore: T;
-} & SwitchInitParams<DataSpecifications[T]['def']>;
-/**
- * BindedSwitch is a switch that is bound to a store item.
- * When the store item changes, the switch is updated.
- * When the switch is clicked, the store item is updated.
- */
-export declare class BindedSwitch<T extends keyof DataSpecifications> extends Switch<DataSpecifications[T]['def']> {
-    /**
-     * Ident of store item to bind switch with
-     */
-    bindStore: T;
-    constructor(params: BindedSwitchInitParams<T>);
-    unmount(): void;
-    set(value: DataSpecifications[T]['def'], _uiIdent?: string | void): void;
-    /**
-     * Handles the click event for the BindedSwitch component.
-     * @param command - The command to execute.
-     * @param value - The value to pass to the command.
-     */
-    click(command: string, value: string | DataSpecifications[T]['def']): void;
-    /**
-     * Optional method to re-render itself
-     */
-    render?(): void;
-    /**
-     * Optional redraw used in some instances
-     */
-    protected redraw?(): void;
-    protected getEl(value: DataSpecifications[T]['def']): HTMLElement | null;
-}

package/types/client/BottomTagPlugin.d.ts

@@ -1,8 +0,0 @@
-import { WindowPlugin } from '@windy/WindowPlugin';
-import type { WindowPluginInitParams } from '@windy/WindowPlugin';
-import type { BottomTagPlugins } from '@windy/plugins.d';
-export type BottomTagPluginInitParams<P extends keyof BottomTagPlugins> = Omit<WindowPluginInitParams<P>, 'ident'> & Pick<BottomTagPlugin<P>, 'ident'>;
-export declare class BottomTagPlugin<P extends keyof BottomTagPlugins> extends WindowPlugin<P> {
-    ident: P;
-    constructor(params: BottomTagPluginInitParams<P>);
-}

package/types/client/DraggableDiv.d.ts

@@ -1,21 +0,0 @@
-/**
- * Enables Scrollable DIV to be dragged left/right with mouse on non touch devices
- */
-export type DraggableDivInitParams = {
-    scrollEl: HTMLElement;
-};
-export declare class DraggableDiv {
-    /**
-     * Major element
-     */
-    private scrollEl;
-    private inertiaAnim;
-    constructor(params: DraggableDivInitParams);
-    private getX;
-    /**
-     * Scrolling the table on a basis of dragging with a mouse (non-touch devices)
-     * -- touch should be supported naturally by scrolling the DIV
-     * https://ariya.io/2013/11/javascript-kinetic-scrolling-part-2
-     */
-    private startDrag;
-}

package/types/client/GhostBox.d.ts

@@ -1,17 +0,0 @@
-import type { Drag } from './Drag';
-export type GhostBoxInitParams = {
-    drag: Drag;
-    progressLine: HTMLElement;
-    ghost: HTMLElement | null;
-    updateGhost?(event: MouseEvent | TouchEvent): void;
-};
-export declare class GhostBox {
-    private drag;
-    progressLine: HTMLElement;
-    ghost: HTMLElement | null;
-    constructor(params: GhostBoxInitParams);
-    private updateGhost;
-    private onGhostMouseEnter;
-    private onGhostMouseLeave;
-    private onGhostMouseMove;
-}

package/types/client/Legend.d.ts

@@ -1,6 +0,0 @@
-export declare class Legend {
-    el: HTMLDivElement;
-    constructor(el: HTMLDivElement);
-    onclick(): void;
-    render(): void;
-}

package/types/client/LongTap.d.ts

@@ -1,21 +0,0 @@
-import type { HapticsPlugin } from '@capacitor/haptics';
-export type LongTapInitParams = Pick<LongTap, 'el'> & {
-    useHaptics?: boolean;
-    onClick?(e: MouseEvent | TouchEvent): void;
-    onLongTap?(ev: MouseEvent | TouchEvent): void;
-};
-export declare class LongTap {
-    el: HTMLElement;
-    useHaptics: boolean;
-    haptics: HapticsPlugin | null;
-    timer: ReturnType<typeof setTimeout> | null;
-    longPressed: boolean;
-    constructor(params: LongTapInitParams);
-    onClick(_e: MouseEvent | TouchEvent): void;
-    onLongTap(_e: MouseEvent | TouchEvent): void;
-    onCLickPressed(e: MouseEvent | TouchEvent): void;
-    longTapPressed(e: TouchEvent): void;
-    touchStart(e: TouchEvent): void;
-    touchEnd(): void;
-    clearLongPressTimer(): void;
-}