@windycom/plugin-devtools 1.0.1

package/types/tileInterpolator.d.ts

@@ -0,0 +1,27 @@
+/**
+ *
+ * # @windy/tileInterpolator
+ *
+ * Instance of class TileInterpolator, that extends DataTiles. Interpolates single x,y map point
+ * (for purpose of picker or POIs) into real meterological values (at that point).
+ * Can work ONLY with CanvasTileLayer instance
+ *
+ * @module tileInterpolator
+ */
+import { DataTiler } from '@windy/DataTiler';
+import type { PixelInterpolationFun, CoordsInterpolationFun } from '@windy/tileInterpolator.d';
+import type { DataTile } from './dataLoader';
+import type { ExtendedTileParams } from '@windy/DataTiler.d';
+import type { FullRenderParameters } from '@windy/Layer.d';
+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;
+    /**
+     * Request to build interpolate function for purpose of picker & other stuff
+     * and since DataTiler is async, returns this function
+     * in a callback
+     */
+    createFun(this: this, cb: this['cb']): void;
+    tilesReady(dTiles: DataTile[][], mapParams: ExtendedTileParams, params: FullRenderParameters): void;
+}
+export declare const tileInterpolator: TileInterpolator;

package/types/tileLayerInstance.d.ts

@@ -0,0 +1,2 @@
+import type { TileLayerCanvas as ITileLayerCanvas } from '@windy/TileLayerCanvas.d';
+export declare const tileLayer: ITileLayerCanvas;

package/types/timestampUtils.d.ts

@@ -0,0 +1,5 @@
+import type { Timestamp } from '@windy/types';
+/**
+ * Finds closest timestamp index
+ */
+export declare function getClosestTimestampIndex(timestamps: Timestamp[], searchedTimestamp: Timestamp, allowOutOfRange: boolean): number | undefined;

package/types/trans.d.ts

@@ -0,0 +1,68 @@
+import type { SupportedLangFiles, Translations } from '@windy/lang-files.d';
+import type { LoadedTranslations, LoadingOptions, TransFileInfo } from '@windy/trans.d';
+export declare const files: Record<keyof SupportedLangFiles, TransFileInfo>;
+/**
+ * key-value pairs with all loaded lang strings
+ */
+declare const trans: LoadedTranslations;
+/**
+ * Preferred language which does not existed in translations (for statistics purposes)
+ */
+declare let missingLang: string | undefined;
+/**
+ * Get file from storage, checks it version number and if
+ * fits current version returns it. If file is not in storage downloads a file
+ * and stores it in storage.
+ *
+ * Handles versioning of the file, so each new versionof client get its correct file.
+ *
+ * If filename is relative filename (set in options). For example for 'lang/cs.json'
+ * we try to download /v5.0/lang/cz.json'
+ *
+ * Can also store files with absolute URLs
+ *
+ * @param  {string} filename Filename (e.g. 'lang/cs.json')
+ * @param  {Object} options Optionally custom options
+ * @returns Resolves with contents of loaded file (key-value pairs)
+ */
+declare const getFile: (filename: string, options?: LoadingOptions) => Promise<Translations>;
+/**
+ * Loads external language file and attach it as a source of translations. Missing translations are presented in default english lang.
+ * It does nothing in case of english, as it is already loaded by default.
+ *
+ * @param id Id of translation file
+ * @param lang Optionally forced language, client lang is used by default
+ * @returns Translations in key-pair object. Missing translations are presented in default english lang.
+ */
+declare const loadLangFile: (id: keyof SupportedLangFiles, lang?: "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") => Promise<void | Translations>;
+/**
+ * Replace all `[data-*]` translation tags with proper translation in HTML element. It overrides its innerHTML
+ * Supported data suffixes: 'title', 'placeholder', 't', 'afterbegin', 'beforeend', 'tooltipsrc'
+ *
+ * @param element HTML element where tags should be replaced
+ * @example
+ * ```
+ * data-t="PHRASE"
+ *
+ * data-afterbegin=""
+ * data-beforeend=""
+ * data-tooltipsrc="PHRASE"
+ *
+ * <p>
+ *   <!-- afterbegin -->
+ *   foo
+ *   <!-- beforeend -->
+ * </p>
+ * ```
+ */
+declare const translateDocument: <T extends HTMLElement>(element: T) => void;
+/**
+ * @module trans
+ *
+ * - handles all i18n tasks
+ * - detects desired language
+ * - lazy loads language file
+ * - translates required part of a DOM (with many limitations)
+ * - returns translated strings for later use in app
+ */
+export { getFile, loadLangFile, missingLang, trans as t, translateDocument };

package/types/ts-interfaces.d.ts

@@ -0,0 +1,66 @@
+declare interface HTMLCanvasElement extends HTMLElement {
+    getContext(
+        contextId: 'experimental-webgl',
+        options?: WebGLContextAttributes,
+    ): WebGLRenderingContext | null;
+}
+
+// We use <const> typed arrays (rootScope), but we want to allow `includes` check for all similar types.
+// eg. for <const>['rain', 'thunder'] we want to allow `includes('abc'), but still disallow `includes(true)`
+// this does the job and retype property if result is true (type guards)
+declare interface ReadonlyArray<T> {
+    includes<U>(
+        x: U & (T & U extends never ? never : unknown),
+    ): x is U & (T & U extends never ? never : T);
+}
+
+// And same for Array
+declare interface Array<T> {
+    includes<U>(
+        x: U & (T & U extends never ? never : unknown),
+    ): x is U & (T & U extends never ? never : T);
+}
+
+// Make Object.keys generic and do not return the stupid string[] everytime!
+/* eslint-disable */
+declare interface ObjectConstructor {
+    keys<T extends object>(o: T): (keyof T)[];
+}
+/* eslint-enable */
+
+declare interface Element {
+    webkitRequestFullscreen(options?: FullscreenOptions): Promise<void> | undefined;
+    mozRequestFullScreen(options?: FullscreenOptions): Promise<void>;
+    msRequestFullscreen(options?: FullscreenOptions): Promise<void>;
+}
+
+declare interface Document {
+    webkitExitFullscreen(): Promise<void> | undefined;
+    mozCancelFullScreen(): Promise<void>;
+    msExitFullscreen(): Promise<void>;
+}
+
+declare interface DocumentOrShadowRoot {
+    readonly webkitFullscreenElement: Element | null;
+    readonly mozFullScreenElement: Element | null;
+    readonly msFullscreenElement: Element | null;
+}
+
+// parseInt & parseFloat work great even for number
+declare function parseInt(string: string | number, radix?: number): number;
+declare function parseFloat(string: string | number): number;
+
+// isNaN works great even for undefined
+declare function isNaN(number?: number): boolean;
+
+// TS thinks we have nodejs application for some reason... retype timers to the DOM variant
+/* eslint-disable */
+declare module 'timers' {
+    global {
+        function clearInterval(handle?: number): void;
+        function clearTimeout(handle?: number): void;
+        function setTimeout(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
+        function setInterval(handler: TimerHandler, timeout?: number, ...arguments: any[]): number;
+    }
+}
+/* eslint-enable */

package/types/ts-types.d.ts

@@ -0,0 +1,43 @@
+// When we need to ensure some interface implements type/interface (strict mode, no property can miss or overstay)
+// TS has no support for "interface implements interface" yet, so we need to use this helper
+declare type Implements<
+    T,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    R extends T & keyof R extends keyof T ? (keyof T extends keyof R ? any : never) : never,
+> = R;
+
+/**
+ * Avoid optional parameters from interface/type
+ *
+ * @example
+ * ExcludeOptional<{ a: string; b?: string }> => { a: string }
+ */
+declare type ExcludeOptional<T> = {
+    [P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>> ? T[P] : never;
+};
+
+/** `key: value[] | undefined` to `key: value | undefined` */
+declare type UnwrapArray<T> = T extends (infer U)[] ? U : T;
+
+/** Trims undefined from tuple.
+ *
+ * @example
+ * [string, undefined] => [string, undefined] | [string]
+ * [string, string | undefined] => [string, string | undefined] | [string]
+ * [string, string | undefined, string | undefined] => [string, string | undefined, string | undefined] | [string, string | undefined] | [string]
+ * [string, string | undefined, string] => [string, string | undefined, string]
+ **/
+declare type TrimUndefinedFromRight<T extends unknown[]> = T extends [...infer R, infer H]
+    ? undefined extends H
+        ? TrimUndefinedFromRight<R> | [...R, H]
+        : [...R, H]
+    : T;
+
+/**
+ * Converts any type to array.
+ *
+ * @example
+ * string => [string];
+ * string[] => string[]
+ **/
+declare type Arrayify<T> = T extends [...infer R] ? [...R] : [T];

package/types/types.d.ts

@@ -0,0 +1,308 @@
+import weatherTable from '@plugins/_shared/detail-render/weatherTable';
+import { WeatherParameters, LatLon } from './interfaces';
+
+/**
+ * ISO date string representation of the Date
+ */
+export type ISODateString = string;
+
+/**
+ * Timestamp or any time duration in ms
+ */
+export type Timestamp = number;
+
+/**
+ * Path in a form of YYYY/MM/DD/HH or YYYYMMDDHH based on minifest/calendar version
+ */
+export type Path = string;
+
+/**
+ * Valid subscription tiers
+ */
+export type SubTier = 'premium' | null;
+
+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 recived 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 };
+
+/**
+ * Meteorologigal numerial value (usually in default metric as delivered from backend)
+ */
+export type NumValue = number;
+
+export type NumOrNull = NumValue | null;
+
+/**
+ * Format for writing a date as "YYYY-MM-DD"
+ */
+export type YearMonthDay = string;
+
+export type StationType = 'ad' | 'wmo' | 'madis' | 'buoy' | 'dbuoy' | 'pws' | 'ship';
+export type PoiType = 'airq' | 'pgspots' | 'surfspots' | 'radiation' | 'tide';
+export type ExtendedStationType = StationType | 'radiation' | 'airq';
+
+export type StationId = `${ExtendedStationType}-${string}`;
+
+/**
+ * Type of POI that detail can be open with
+ */
+export type StationOrPoiType = StationType | PoiType;
+
+export type FlightCategory = 'I' | 'V' | 'L' | 'M' | 'U';
+
+/**
+ * Allowed type of tides
+ */
+export type TideIdent = 'HT' | 'LT' | 'ME' | 'MF' | 'NE' | 'NF' | 'SE' | 'SF' | 'FT' | 'ET';
+
+export type AqiPollutant =
+    | 'bc'
+    | 'co'
+    | 'co2'
+    | 'no'
+    | 'no2'
+    | 'nox'
+    | 'o3'
+    | 'pm10'
+    | 'pm25'
+    | 'so2';
+
+/**
+ * Fully enclosed and valid HTML string, that can be inserted as innerHTML to DOM
+ * NEVER use for partial HTML codes
+ */
+export type HTMLString = string;
+
+/**
+ * Supported types or table rows as used by @plugin/detail-render and @plugin/detail
+ */
+export type DetailRows = keyof typeof weatherTable;
+
+/**
+ * Width/Height or screenposition in Pixels
+ */
+export type Pixel = number;
+
+export type SveltePluginIdent = `@plugins/${keyof import('@windy/plugins.d').SveltePlugins}`;
+
+export type SveltePanePluginIdent =
+    `@plugins/${keyof import('@windy/plugins.d').SveltePanePlugins}`;
+
+export type TagPluginIdent = `@plugins/${keyof import('@windy/plugins.d').TagPlugins}`;
+
+export type BottomTagPluginIdent = `@plugins/${keyof import('@windy/plugins.d').BottomTagPlugins}`;
+
+export type PlainPluginIdent = `@plugins/${keyof import('@windy/plugins.d').PlainPlugins}`;
+
+export type AllPluginIdent = `@plugins/${keyof import('@windy/plugins.d').Plugins}`;
+
+export type MeteogramLayers = 'dewpoint' | 'gh' | 'rh' | 'temp' | 'wind_u' | 'wind_v';
+
+export type MeteogramLevels =
+    | '950h'
+    | '925h'
+    | '900h'
+    | '850h'
+    | '800h'
+    | '700h'
+    | '600h'
+    | '500h'
+    | '400h'
+    | '300h'
+    | '200h'
+    | '150h'
+    | '1000h'
+    | 'surface';
+
+export type CapAlertSeverity /** moderate **/ =
+    | 'M'
+    /** severe **/
+    | 'S'
+    | /** extreme **/ 'E'
+    | /** unknown **/ 'A';
+
+export type CapAlertType =
+    | 'T' /** thunderstorm **/
+    | 'R' /** rain **/
+    | 'H' /** heat **/
+    | 'W' /** wind **/
+    | 'F' /** flood **/
+    | 'L' /** low temp **/
+    | 'C' /** coastal warning **/
+    | 'I' /** fires **/
+    | 'G' /** fog **/
+    | 'N' /** tornado **/
+    | 'Q' /** air quality  */
+    /** these two are new not implemented in client **/
+    | 'S' /** snow ice **/
+    | 'A' /** avalanche **/
+    | '-' /** invalid */;
+
+export type CapAlertInfo = Record<
+    string,
+    {
+        event: string;
+        description: string;
+        instruction: string;
+        senderName: string;
+        headline: string;
+    }
+>;
+
+export type RouteType = 'car' | 'vfr' | 'ifr' | 'elevation' | 'boat' | 'airgram';
+
+export type RouteMotionSpeed = {
+    [key in RouteType]: number;
+};
+
+export type LocationPrefecernces = {
+    status: 'notDetermined' | 'restricted' | 'denied' | 'authorized' | 'unknownState';
+};
+
+export type NoticicationPrefecernces = {
+    status: 'notDetermined' | 'denied' | 'authorized' | 'provisional' | 'unknownState';
+};
+
+export type GpsPreferences = {
+    status: 'denied' | 'authorized';
+};
+
+export type BatteryPreferences = {
+    status: 'denied' | 'authorized';
+};
+
+export type WidgetNotificationPreferences = {
+    status: 'denied' | 'authorized';
+};
+
+export type GoogleServicesPreferences = {
+    status: 'denied' | 'authorized';
+};
+
+export type ErrorCategory = 'location' | 'notification' | 'iCloud' | 'battery';
+
+export type ShowableError = {
+    errorId:
+        | 'ICLOUD_9' /** iCloud denied by user settings **/
+        | 'ICLOUD_25' /** Users iCloud has full storage **/
+        | 'LOC_1' /** Location services disabled in devide (for device Android) **/
+        | 'LOC_2' /** Location services disabled for application */
+        | 'NOTIF_1' /** Notification services disabled **/
+        | 'BATTERY_1' /** Battery usage restricted */
+        | 'BACKGROUND_LOCATION_1' /** Background location usage disabled */
+        | 'WIDGET_NOTIFICATION_1' /** Notifications disabled for widgets */;
+    category: ErrorCategory;
+};
+
+export type ShowableErrors = {
+    unresolved: Map<string, ShowableError>;
+    closed: Set<string>;
+};
+
+/**
+ * Overlay categories used for better UI navigation
+ */
+export type MenuCategory =
+    | 'wind'
+    | 'rain'
+    | 'sea'
+    | 'airQ'
+    | 'drought'
+    | 'temp'
+    | 'warnings'
+    | 'clouds';
+
+/**
+ * Overlay categories used for better UI navigation
+ */
+export type MenuItems = MenuCategory | 'all' | 'search';
+
+/**
+ * How long should picker-mobile stay open after user interaction
+ * It is string because of UI component dropdown returns string
+ */
+export type PickerMobileTimeout = '3' | '6' | '9' | '12' | 'always';
+
+/**
+ * Only these first level paths are allowe to be used in log
+ */
+export type LogPaths =
+    | keyof WeatherParameters
+    | 'version'
+    | 'plugin'
+    | 'pois'
+    | 'startup'
+    | 'subscription'
+    | '404'
+    | 'promo'
+    | 'airport'
+    | 'appRating'
+    | 'articles'
+    | 'detail2'
+    | 'onboarding'
+    | 'station'
+    | 'weather'
+    | 'events';
+
+/**
+ * Type of user consent
+ */
+export type ConsentType = 'pending' | 'rejected' | 'analytics';
+
+export type ProductCategory = 'analysis' | 'forecast';
+
+export type ProductIdent =
+    | 'nam-conus'
+    | 'nam-hawaii'
+    | 'nam-alaska'
+    | 'icon-eu'
+    | 'icon-d2'
+    | 'arome'
+    | 'arome-antilles'
+    | 'arome-reunion'
+    | 'cams-global'
+    | 'cams-eu'
+    | 'icon-global'
+    | 'icon-gwam'
+    | 'icon-ewam'
+    | 'hrrr-alaska'
+    | 'hrrr-conus'
+    | 'bom-access'
+    | 'ukv'
+    | 'gfs'
+    | 'gfs-wave'
+    | 'ecmwf-hres'
+    | 'ecmwf-wam'
+    | 'ecmwf-efi'
+    | 'mbeurope'
+    | 'cmems'
+    | 'intersucho'
+    | 'intersucho-firerisk'
+    | 'nasa-firms';
+
+export type PickerOpener = LatLon & { id: string };
+
+export type ExternalPluginIdent = `windy-plugin-${string}`;

package/types/user.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @module user
+ *
+ * 1) Wrapper for the user store object.
+ * 2) Loads user info from the server.
+ * 3) Handles user authentication.
+ * 4) Renders user avatar.
+ *
+ * data-user='logged-in' or 'logged-out' attr is added to the body tag when we know the state of the user (a CSS way of isUserLoggedIn function).
+ * it's to avoid unnecessary render of "login" button when the user is logged in, but we still wait for the server response
+ */
+/**
+ * We use ./filename to motivate rollup treeshaking
+ */
+import type { User } from '@windy/dataSpecifications.d';
+import type { HttpPayload } from '@windy/http.d';
+import type { AccountLoginResponse, UserInfo } from '@windy/user.d';
+export declare const isLoggedIn: () => boolean;
+export declare const isPublisher: () => boolean;
+export declare const getInfo: () => User | null;
+/**
+ * Safe way how to retrieve use avatar
+ * @returns link to user avatar or default avatar
+ */
+export declare const getAvatar: () => string;
+export declare const getEmail: () => string;
+export declare const getUsername: () => string;
+export declare const getUserId: () => number;
+/**
+ * Open login plugin so that user can log in
+ */
+export declare const login: () => void;
+export declare const register: () => void;
+/**
+ * Log out the user - remove credentials and reload all things that depends on logged-in user
+ */
+export declare const logout: () => void;
+export declare const setExplicitConsent: (analytics: boolean) => void;
+export declare const setImplicitConsent: () => void;
+/**
+ * Check if we have received valid auth object and if yes, save it and open user plugin
+ *
+ * @param userInfo user info from account or node users
+ * @returns true if user is authenticated
+ */
+export declare const checkAuth: (userInfo: UserInfo) => boolean;
+/**
+ * Get info about current user from account
+ *
+ * @returns Pending HttpPayload with UserInfo or null if not authenticated
+ * @throws An exception when HTTP request fails
+ */
+export declare const reloadInfo: () => Promise<HttpPayload<UserInfo> | null>;
+export declare const handleLoginResponse: (response: HttpPayload<AccountLoginResponse>) => void;