@windycom/plugin-devtools 3.0.1 → 3.0.3

package/types/client/throttler.d.ts

@@ -0,0 +1,32 @@
+import type { LeafletGlMap } from '@leafletGl';
+export declare class Throttler {
+    private _workItemEnergyAvailable;
+    private _workItems;
+    private _map;
+    private _interval;
+    private _lastFrameTime;
+    private _maxRefreshMs;
+    /**
+     * How much energy is accumulated per frame.
+     * This number can also be decimal.
+     * A work item consumes 1 energy by default.
+     */
+    energyPerFrame: number;
+    maxAccumulatedEnergy: number;
+    constructor(map: LeafletGlMap);
+    /**
+     * Await this function inside an asynchronous work item that might trigger a long-running task.
+     * Returns a promise that resolves once this work item is scheduled to run.
+     * This call ensures that only a certain number of items are permitted to run within a given frame.
+     *
+     * You may optionally pass an abort signal. If the item is aborted, the promise is resolved in the next update.
+     * Distinguishing between regular promise resolve and an abort is the caller's responsibility!
+     *
+     * You may optionally specify a priority for this work item. Default is 0, higher values are scheduled with higher priority.
+     *
+     * You may optionally specify a weight multiplier for this work item. Default is 1. More work items with lower weights may be executed in a single frame.
+     */
+    awaitThrottled(abort?: AbortSignal, priority?: number, weight?: number): Promise<void>;
+    dispose(): void;
+    private _onNewFrame;
+}

package/types/client/tileHelpers.d.ts

@@ -0,0 +1,35 @@
+import { type TileHeader } from '@windy/TileLayerUtils';
+import { type CacheAllocationToken, type Coords } from '@leafletGl';
+import { GlTexture } from '@windy/glUtils';
+import { type CachedTile } from '@windy/tileLayerSource';
+import type { Cache } from '@windy/SwitchableTileCache';
+import type { FullRenderParameters } from '@windy/interfaces';
+export type ReadyTile = {
+    valid: true;
+    tex: GlTexture;
+    coords: Coords;
+    header: TileHeader;
+    _token: CacheAllocationToken<CachedTile>;
+} | {
+    valid: false;
+    _token: CacheAllocationToken<CachedTile>;
+};
+/**
+ * Helper functions that creates a (Tile)Cache instance for use in Windy's TileLayer.
+ * The cache is configured to use {@link tileLayerSource} to fetch tiles and headers
+ * and then preprocess them on the GPU using {@link TileLayerPreprocessorStandalone}
+ * configured to the supplied {@link FullRenderParameters}.
+ *
+ * The returned `Cache` object contains the `TileCache` instance and a `destroy`
+ * function for disposing of the {@link TileLayerPreprocessorStandalone}.
+ * (But NOT the `TileCache`! It must be destroyed separately.)
+ *
+ * This function is async, since it must wait for the {@link TileLayerPreprocessorStandalone} to initialize.
+ *
+ * @param params - Full render parameters for the desired layer.
+ */
+export declare function makeTileLayerCache(params: FullRenderParameters): Promise<Cache<ReadyTile>>;
+/**
+ * Replaces {z}, {x} and {y} in the URL template with the given tile coords.
+ */
+export declare function applyUrlTemplate(urlTemplate: string, coords: Coords): string;

package/types/client/tileInterpolator.d.ts

@@ -12,7 +12,7 @@ import { DataTiler } from '@windy/DataTiler';
 import type { PixelInterpolationFun, CoordsInterpolationFun } from '@windy/interpolatorTypes';
 import type { DataTile } from './dataLoader';
 import type { ExtendedTileParams } from '@windy/DataTiler.d';
-import type { FullRenderParameters } from '@windy/Layer.d';
+import type { FullRenderParameters } from '@windy/interfaces';
 export declare class TileInterpolator extends DataTiler {
     cb<T extends true | false>(f1: CoordsInterpolationFun, // async interpolator does not use fakeFun with null return type
     f2: PixelInterpolationFun | (() => null), isAsync?: T & (true | false)): void;

package/types/client/tileLayerInterpolator.d.ts

@@ -0,0 +1,40 @@
+import type { PixelInterpolationFun, CoordsInterpolationFun, InterpolatorPossibleReturns } from '@windy/interpolatorTypes';
+import type { FullRenderParameters } from '@windy/interfaces';
+type TileLayerPickerCallback = (f1: CoordsInterpolationFun, f2: PixelInterpolationFun | (() => null)) => void;
+export declare class TileLayerInterpolator {
+    private _debugElement?;
+    private _pixelReader;
+    private _lastDataZoom;
+    private _pendingLoads;
+    private _latestParams?;
+    private _requestGiveId;
+    private _cache;
+    private _cachedRequestsByTileUrl;
+    constructor();
+    paramsChanged(params: FullRenderParameters): void;
+    /**
+     * Request to build interpolate function for purpose of picker & other stuff
+     * and since DataTiler is async, returns this function
+     * in a callback
+     */
+    createFun(callback: TileLayerPickerCallback): void;
+    destroy(): void;
+    /**
+     * @summary Samples data from map under the given mercator coordinates
+     * @param mercatorX Mercator X relative coordinate in range <0.0, 1.0>
+     * @param mercatorY Mercator Y relative coordinate in range <0.0, 1.0>
+     * @returns Decoded and interpolated value (ready for display)
+     */
+    sampleAtMercator(mercatorX: number, mercatorY: number, abort?: AbortController, renderParams?: FullRenderParameters): Promise<InterpolatorPossibleReturns>;
+    private _getIntZoom;
+    private _onZoomEnd;
+    private _keyDeleted;
+    private _clearAllWaitingTiles;
+    /**
+     * @summary Performs the actual read from the tile texture
+     * @param tile Tile to sample
+     */
+    private _sampleDataFromTile;
+}
+export declare const tileLayerInterpolator: TileLayerInterpolator;
+export {};

package/types/client/tileLayerSource.d.ts

@@ -0,0 +1,98 @@
+import { LeafletGlMap, type CacheAllocationToken } from '@leafletGl';
+import { type TileHeader } from '@windy/TileLayerUtils';
+import { Evented } from '@windy/Evented';
+export type CachedTile = {
+    /**
+     * When true, the tile has valid data.
+     * When false, the loading of the tile has failed.
+     */
+    valid: true;
+    /**
+     * The WebGL texture containing this tile's image, without the header.
+     * Default filtering is linear and wrap mode is clamp-to-edge.
+     * Tile image size is 257x257.
+     */
+    tex: WebGLTexture;
+    /**
+     * The extracted tile header.
+     */
+    header: TileHeader;
+    url: string;
+} | {
+    valid: false;
+    url: string;
+};
+type TileLayerSourceEvents = {
+    /**
+     * @ignore
+     */
+    keydeleted: string;
+};
+/**
+ * A reference counted cache for loading generic TileLayer tiles.
+ * Automatically extracts tile headers and uploads the images into WebGL textures.
+ */
+declare class TileLayerSource extends Evented<TileLayerSourceEvents> {
+    private _gl;
+    private _cache;
+    private _canvas;
+    private _ctx;
+    private _disposed;
+    constructor();
+    /**
+     * Initializes the tile source with a WebGL context.
+     */
+    init(map: LeafletGlMap): void;
+    /**
+     * Asynchronously gets a tile. The returned token must later be "freed" by passing it to {@link free}.
+     * The returned texture is kept in cache for as long as any token referencing it exists.
+     * Same semantics as {@link ReferenceCountedCache.retrieve}.
+     */
+    get(url: string, abort?: AbortSignal): Promise<CacheAllocationToken<CachedTile>>;
+    /**
+     * Waits for a tile for a given url to be loaded, but does not trigger the load itself.
+     * Loading of the value must be started elsewhere by calling {@link get}.
+     * Returned token must later be freed using {@link free}, same as with tokens returned from {@link get}.
+     */
+    awaitTile(url: string, abort?: AbortSignal): Promise<CacheAllocationToken<CachedTile>>;
+    /**
+     * Returns a token and deletes its associated texture if it is no longer needed. Same semantics as {@link ReferenceCountedCache.delete}.
+     */
+    free(tile: CacheAllocationToken<CachedTile>): void;
+    /**
+     * Releases all resources held by this TileLayerSource.
+     */
+    dispose(): void;
+    private _imageBitmapToUint8Array;
+}
+/**
+ * A singleton instance of a {@link TileLayerSource}.
+ */
+export declare const tileLayerSource: TileLayerSource;
+export declare function fetchImageBlob(url: string, signal?: AbortSignal): Promise<Blob | null>;
+export declare function extractTileHeader(imageBitmapWithHeader: ImageBitmap): Promise<ImageAndHeader>;
+export type DecodedTile = {
+    image: ImageBitmap | null;
+    url: string;
+};
+export type ImageAndHeader = {
+    image: ImageBitmap;
+    header: TileHeader;
+};
+export type DecodedTileWithHeader = {
+    url: string;
+    imageAndHeader: ImageAndHeader | null;
+    /**
+     * @internal
+     * Internal, do not use or modify.
+     *
+     * Tiles with header internally use the headerless cache to fetch the image,
+     * and only then they extract the header.
+     * This is the allocation token of the unprocessed tile image referenced by this tile.
+     */
+    _headerlessToken: CacheAllocationToken<DecodedTile>;
+};
+export type TileToken<T extends DecodedTile | DecodedTileWithHeader> = CacheAllocationToken<T> & {
+    _hasHeader: T extends DecodedTileWithHeader ? true : false;
+};
+export {};

package/types/client/timestampUtils.test.d.ts

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

package/types/client/topMessage.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Top message service that displays messages at the top of the screen
+ * Ensures only one top message is displayed at a time
+ */
+import { Window } from '@windy/Window';
+import type { HTMLString } from '@windy/types';
+export interface TopMessageOptions {
+    /** Type of the massage */
+    type: 'success' | 'error' | 'warning';
+    /** HTML content of the message */
+    html: HTMLString;
+    /** Auto-close timeout in milliseconds */
+    timeout?: number;
+    /** Called on message click */
+    onclick?: () => void;
+}
+/**
+ * Display a top message. If another message is currently displayed, it will be closed first.
+ * @param options Configuration for the top message
+ * @returns Promise that resolves when the message is displayed
+ */
+export declare const displayTopMessage: ({ html, timeout, onclick, type, }: TopMessageOptions) => Promise<Window>;

package/types/client/user.d.ts

@@ -26,6 +26,7 @@ export declare const getAvatar: () => string;
 export declare const getEmail: () => string;
 export declare const getUsername: () => string;
 export declare const getUserId: () => number;
+export declare const isLoggedInPromise: () => Promise<boolean>;
 /**
  * Open login plugin so that user can log in
  */

package/types/client/userAlerts.d.ts

@@ -1,5 +1,4 @@
 import type { AlertRequest, AlertResponse, AlertCheckResponse } from '@windy/alerts.d';
-import type { Fav } from '@windy/favs.d';
 import type { LatLon } from '@windy/interfaces';
 export declare enum AlertStatus {
     Triggered = "triggered",
@@ -52,9 +51,6 @@ export declare enum CloudCoverage {
     Overcast = "OVC"
 }
 export declare function getAlertTimestamps(alertId: string): Promise<AlertCheckResponse>;
-export declare function getAlertV3(alertId: string): Promise<Fav & {
-    type: 'alert';
-}>;
 export declare function getAlerts(): Promise<AlertResponse[]>;
 export declare function getAlert(alertId: string): Promise<AlertResponse | null>;
 export declare function createAlert(data: AlertRequest): Promise<void>;

package/types/client/userConsent.d.ts

@@ -1,6 +1,4 @@
-export declare const launchConsentWindow: () => void;
 export declare const setExplicitConsent: (analytics: boolean) => void;
-export declare const setImplicitConsent: () => void;
 export declare const checkConsent: (userInfo?: {
     requiresCookieConsent: boolean;
 }) => void;

package/types/client/userFavs.d.ts

@@ -1,29 +1,30 @@
-import type { Fav, FavId } from '@windy/favs';
+import type { FavFragment, Fav, FavId } from '@windy/favs.d';
+import type { Timestamp } from '@windy/types.d';
 export declare const emitChange: () => void;
 /**
  * Adds a fav to the db
  */
-export declare const add: () => Promise<FavId | null>;
+export declare const add: (item: FavFragment) => Promise<FavId | null>;
 /**
  * Update Fav in the db
  */
-export declare const update: () => Promise<FavId | null>;
+export declare const update: (id: FavId, properties2update: Partial<Fav>) => Promise<FavId | null>;
 /**
  * Remove fav from db
  */
-export declare const remove: () => Promise<void>;
+export declare const remove: (id: FavId) => Promise<void>;
 /**
  * Toggle pinning fav to top or to homepage
  */
-export declare const togglePin: () => Promise<void>;
+export declare const togglePin: (id: FavId, whereToPin: 'pin2top' | 'pin2homepage', forcedTimestamp?: Timestamp) => Promise<void>;
 /**
  * Find all favs that match given criteria
  */
-export declare const find: () => Promise<Fav[]>;
+export declare const find: (query: Partial<Fav> | ((f: Fav) => boolean)) => Promise<Fav[]>;
 /**
  * Same as find but always returns only the first match
  */
-export declare const findOne: () => Promise<Fav | undefined>;
+export declare const findOne: (query: Partial<Fav> | ((f: Fav) => boolean)) => Promise<Fav | undefined>;
 /**
  * Returns all favs as array
  */
@@ -31,16 +32,20 @@ export declare const getAll: () => Promise<Fav[]>;
 /**
  * Quick check if fav with given ids exists
  */
-export declare const isFav: () => Promise<boolean>;
+export declare const isFav: (query: Partial<FavFragment>) => Promise<boolean>;
 /**
  * Toggles fav (adds or removes) from db
  */
-export declare const toggle: () => Promise<boolean>;
+export declare const toggle: (query: Partial<FavFragment>, item: FavFragment) => Promise<boolean>;
 /**
  * Checks if fav exists
  */
-export declare const hasKey: () => Promise<boolean>;
+export declare const hasKey: (key: FavId) => Promise<boolean>;
 /**
- * Removes all favs from the device TODO: Call after logging out
+ * Since favs does not contain cc (country code) this enhances the fav with cc
+ * so we could make better use of it in the GUI (search, fav list).
+ *
+ * Once, the fav is enhanced with cc, it will be stored and synced with cloud.
+ * Uses try/catch to handle errors gracefully.
  */
-export declare const removeAllFavsFromDevice: () => Promise<void>;
+export declare const enhanceWithCountryCode: (fav: Fav) => Promise<Fav>;

package/types/client/utils.d.ts

@@ -1,32 +1,28 @@
-import { HttpError } from './errors';
+/// <reference types="svelte" />
+import { HttpError } from '@windy/errors';
 import type { RegistrationError } from '@capacitor/push-notifications';
-import type { RGBA } from '@windy/Color.d';
 import type { QueryStringSource } from '@windy/http.d';
 import type { LatLon, LinearScale, TilePoint } from '@windy/interfaces.d';
 import type { RGBNumValues } from '@windy/interpolatorTypes';
-import type { ExtendedStationType, HTMLString, NumOrNull, Timestamp, ParsedQueryString } from '@windy/types.d';
+import type { ExtendedStationType, HTMLString, NumOrNull, NumValue, Path, Timestamp, TimeRangeMs, ParsedQueryString, RGBAString, RGBString, ColorGradientString, RGBA, Hours, YearMonthDay } from '@windy/types.d';
+import type { Vector3 } from '@windy/math';
+import type { Readable, Subscriber, Unsubscriber } from 'svelte/store';
 /**
- * One minute in ms.
- *
- * @type {Timestamp}
+ * One minute duration in ms.
  */
-export declare const tsMinute: Timestamp;
+export declare const tsMinute: TimeRangeMs;
 /**
- * One hour in ms.
- *
- * @type {Timestamp}
+ * One hour duration in ms.
  */
-export declare const tsHour: Timestamp;
+export declare const tsHour: TimeRangeMs;
 /**
- * One day in ms.
- *
- * @type {Timestamp}
+ * One day duration in ms.
  */
-export declare const tsDay: Timestamp;
+export declare const tsDay: TimeRangeMs;
 /**
- * Long press time in ms. to be used everywhere
+ * Long press time duration in ms.
  */
-export declare const longPressTime: Timestamp;
+export declare const longPressTime: TimeRangeMs;
 /**
  * Converts number to char
  *
@@ -212,14 +208,13 @@ export declare const windDir2html: (wx: WindObject) => HTMLString;
  */
 export declare const isNear: <T extends LatLon, F extends LatLon>(a: T, b: F) => boolean;
 /**
- * Bounds a number to a limits
+ * Clamps a number to a range
  *
- * @param num Number to bound
+ * @param num Number to clamp
  * @param min Minimum
  * @param max Maximum
- * @returns Bounded number
+ * @returns Clamped number
  */
-export declare const bound: (num: number, min: number, max: number) => number;
 export declare const clamp: (num: number, min: number, max: number) => number;
 /**
  * Smoothstep https://en.wikipedia.org/wiki/Smoothstep
@@ -292,7 +287,7 @@ export declare const getAdjustedNow: (syncTime?: number) => number;
  * @param lang Language code
  * @returns True if language is supported, false otherwise
  */
-export declare const isValidLang: (lang: string) => lang is "en" | "zh-TW" | "zh" | "ja" | "fr" | "ko" | "it" | "ru" | "nl" | "cs" | "tr" | "pl" | "sv" | "fi" | "ro" | "el" | "hu" | "hr" | "ca" | "da" | "ar" | "fa" | "hi" | "ta" | "sk" | "uk" | "bg" | "he" | "is" | "lt" | "et" | "vi" | "sl" | "sr" | "id" | "th" | "sq" | "pt" | "nb" | "es" | "de" | "bn";
+export declare const isValidLang: (lang: string) => lang is "id" | "hr" | "th" | "tr" | "en" | "zh-TW" | "zh" | "ja" | "fr" | "ko" | "it" | "ru" | "nl" | "cs" | "pl" | "sv" | "fi" | "ro" | "el" | "hu" | "ca" | "da" | "ar" | "fa" | "hi" | "ta" | "sk" | "uk" | "bg" | "he" | "is" | "lt" | "et" | "vi" | "sl" | "sr" | "sq" | "pt" | "nb" | "es" | "de" | "bn";
 /**
  * Safely joins server name and path
  *
@@ -345,7 +340,7 @@ export declare const download: (data: BlobPart, type: string, name: string) => v
  * @param ident ID of plugin to load
  * @returns Instance of the Capacitor plugin
  */
-export declare const getNativePlugin: <T = unknown>(ident: string) => T;
+export declare function getNativePlugin<T = unknown>(ident: string): T | null;
 /**
  * JQuery like selector
  *
@@ -399,6 +394,21 @@ export declare const getRefs: <N extends HTMLElement, R extends Record<string, H
  * Sanitizes HTML code, escape all XSS dangerous characters
  */
 export declare const sanitizeHTML: (s: string) => string;
+export interface LogErrorDetail {
+    moduleName: string;
+    msg: string;
+    errorObject?: Error | HttpError | Event | ErrorEvent | RegistrationError;
+    additionalInfo?: {
+        /**
+         * Any additional data you want to log alongside the error to provide more context
+         */
+        extra?: Record<string, unknown>;
+        /**
+         * Key-value pairs to use as tags in GlitchTip
+         */
+        tags?: Record<string, string>;
+    };
+}
 /**
  * Custom error logging function.
  *
@@ -409,7 +419,7 @@ export declare const sanitizeHTML: (s: string) => string;
  * @param msg Message to report, the main body of the error
  * @param errObj Whole error object to stringification. It is sent to Kibana under 'error' property
  */
-export declare function logError(moduleName: string, msg: string, errorObject?: Error | HttpError | Event | ErrorEvent | RegistrationError): void;
+export declare function logError(moduleName: string, msg: string, errorObject?: Error | HttpError | Event | ErrorEvent | RegistrationError, additionalInfo?: LogErrorDetail['additionalInfo']): void;
 /**
  * Same as scale linear from d3 library except with different params
  * https://d3js.org/d3-scale/linear
@@ -421,8 +431,9 @@ export declare const scaleLinear: ({ domain, range, clip, }: {
     range: [number, number];
     clip?: boolean;
 }) => LinearScale;
+export declare const maxCanvasRatio = 2;
 /**
- * Unified canvasRatio used in overall Windy. Not bigger then 2
+ * Unified canvasRatio used in overall Windy. Not bigger than maxCanvasRatio
  */
 export declare const canvasRatio: number;
 /**
@@ -466,6 +477,10 @@ export declare const removeDiacritics: (s: string) => string;
  * This differs from the CSS property which capitalizes the first letter of each word.
  */
 export declare const capitalize: (text: string) => string;
+/**
+ * Get unified path format out of ts
+ */
+export declare const getPathFromTs: (ts: Timestamp | Date, replacerPattern?: string) => Path;
 export declare const parseQueryString: (searchQuery: string | undefined) => ParsedQueryString | undefined;
 export declare const seoLangRegex: RegExp;
 /**
@@ -494,3 +509,41 @@ export declare const parseSeoUrl: (url: string) => {
 export declare const startupPath: any;
 export declare const generateUuidV4: () => string;
 export declare const getErrorMessage: (error: unknown) => string;
+/**
+ * Creates a color gradient from array of prepared ones
+ */
+export declare const createColorGradient: (gradient: (RGBAString | RGBString)[], numValues: NumValue[]) => ColorGradientString;
+/**
+ * preventDefault wrapper for event handlers
+ */
+export declare const preventDefault: <E extends Event = Event>(callback: (event: E) => void) => (event: E) => void;
+export declare const openInApp: () => void;
+/**
+ * Given the UTC offset returns local time
+ */
+export declare const toLocalTime: (ts: Timestamp, utcOffset: Hours) => {
+    h: Hours;
+    m: number;
+    day: number;
+    weekDay: number;
+    yearMonthDay: YearMonthDay;
+};
+/**
+ * @summary Extracts positions of the tile coordinates in the per-tile request urls to enabled coordinates extraction
+ *  which is required to modify the original tile request created by maplibre
+ * @param url
+ * @returns
+ */
+export declare function extractTileCoordsUrlPositionsFromParametricUrl(url: string): Vector3;
+/**
+ * @summary Modifies the input leaflet zoom based on the currently used map library
+ *  - maplibre zoom is offset by 1 from the leaflet zoom, since Leaflet uses
+ *  zoom computed wrt 256px tile while maplibre uses 512px tile as base size
+ * @param leafletZoom Leaflet-based zoom level
+ */
+export declare const offsetLeafletZoom: (leafletZoom: number) => number;
+/**
+ * Used for Svelte stores
+ * Sometimes we only want to subscribe to changes in store and don't want to be called with initial value
+ */
+export declare const subscribeToChange: <T>(store: Readable<T>, callback: Subscriber<T>) => Unsubscriber;

package/types/client/utils.test.d.ts

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

package/types/iconfont.d.ts

@@ -189,11 +189,8 @@ export type Iconfont =
     | '<!-- @echo icon-bell-plus -->'
     | '<!-- @echo icon-x -->'
     | '<!-- @echo icon-twitter -->'
-    | '<!-- @echo icon-fire-warning -->'
-    | '<!-- @echo icon-fire-match -->'
-    | '<!-- @echo icon-fire-wind -->'
-    | '<!-- @echo icon-crosshair -->'
-    | '<!-- @echo icon-pushpin -->'
+    | '<!-- @echo icon-bug -->'
+    | '<!-- @echo icon-hammer -->'
     | '<!-- @echo icon-github -->'
     | '<!-- @echo icon-link -->'
     | '<!-- @echo icon-plane-snowflake -->'