@windycom/plugin-devtools 2.0.0 → 3.0.1

package/types/client/trans.d.ts

@@ -1,42 +1,41 @@
-import type { SupportedLangFiles, Translations } from './d.ts.files/lang-files.d';
-import type { LoadedTranslations, LoadingOptions, TransFileInfo } from './d.ts.files/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.
+ * # @windy/trans
  *
- * Handles versioning of the file, so each new versionof client get its correct file.
+ * This module handles all i18n tasks, including detecting the desired language,
+ * lazy loading language files, translating parts of the DOM, and returning
+ * translated strings for later use in the app.
  *
- * If filename is relative filename (set in options). For example for 'lang/cs.json'
- * we try to download /v5.0/lang/cz.json'
+ * English language stings from `main` file are hardcoded in the core by default,
+ * to avoid any undefined strings in DOM. Other languages are loaded on demand.
  *
- * Can also store files with absolute URLs
+ * WARNING: Contrary to previous version, Windy does not support changing language
+ * during a runtime. Once user opts to change the language, whole app must be reloaded.
  *
- * @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)
+ * @module trans
  */
-declare const getFile: (filename: string, options?: LoadingOptions) => Promise<Translations>;
+import type { SupportedLangFiles } from '@windy/lang-files.d';
+import type { LoadedTranslations } from '@windy/types';
+export declare const supportedLangFiles: string[];
 /**
- * Loads external language file and attach it as a source of translations. Missing translations are presented in default english lang.
+ * key-value pairs with all loaded lang strings
+ * WARNING: Typing here is not true... lang files are loaded step-by-step on demand, but it is useless to use `!` everywhere
+ */
+export declare const t: LoadedTranslations;
+/**
+ * Preferred browsers' language (not the used one). Can contain language that is not supported by Windy
+ */
+export declare const navigatorPreferredLang: string;
+export declare const getUrlOfLangFile: (id: keyof SupportedLangFiles) => string;
+/**
+ *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?: "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") => Promise<void | Translations>;
+export declare const loadLangFile: (id: keyof SupportedLangFiles) => Promise<void>;
 /**
- * Replace all `[data-*]` translation tags with proper translation in HTML element. It overrides its innerHTML
+ * Replace. It overrides its innerHTML
  * Supported data suffixes: 'title', 'placeholder', 't', 'afterbegin', 'beforeend', 'tooltipsrc'
  *
  * @param element HTML element where tags should be replaced
@@ -55,14 +54,4 @@ declare const loadLangFile: (id: keyof SupportedLangFiles, lang?: "en" | "zh-TW"
  * </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 };
+export declare const translateDocument: <T extends HTMLElement>(element: T) => void;

package/types/client/user.d.ts

@@ -4,24 +4,20 @@
  * 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
  *
  * @module user
  */
-/**
- * We use ./filename to motivate rollup treeshaking
- */
-import type { User } from './d.ts.files/dataSpecifications.d';
+import '@windy/liveAlerts';
 import type { HttpPayload } from './d.ts.files/http.d';
-import type { AccountLoginResponse, UserInfo } from './d.ts.files/user.d';
+import type { AccountLoginResponse, UserInfo, User, LoginAndFinishAction } from './d.ts.files/user.d';
 /**
- * Quick check is user is loggedIn
+ * Quick check is user is loggedIn.
  */
 export declare const isLoggedIn: () => boolean;
 export declare const getInfo: () => User | null;
+export declare const emptyAvatar = "<!-- @echo IMG_ABSOLUTE_PATH -->/avatar.jpg";
 /**
  * Safe way how to retrieve use avatar
  * @returns link to user avatar or default avatar
@@ -33,14 +29,12 @@ export declare const getUserId: () => number;
 /**
  * Open login plugin so that user can log in
  */
-export declare const login: () => void;
+export declare const login: (finishAction?: LoginAndFinishAction) => 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: () => Promise<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
  *
@@ -48,7 +42,7 @@ export declare const setImplicitConsent: () => void;
  * @param handleConsent should we handle analytics consent (api/info endpoint)
  * @returns true if user is authenticated
  */
-export declare const checkAuth: (userInfo: UserInfo, handleConsent: boolean) => boolean;
+export declare const checkAuth: (userInfoPayload: UserInfo, handleConsent: boolean) => Promise<boolean>;
 /**
  * Get info about current user from account
  *
@@ -56,4 +50,4 @@ export declare const checkAuth: (userInfo: UserInfo, handleConsent: boolean) =>
  * @throws An exception when HTTP request fails
  */
 export declare const reloadInfo: () => Promise<HttpPayload<UserInfo> | null>;
-export declare const handleLoginResponse: (response: HttpPayload<AccountLoginResponse>) => void;
+export declare const handleLoginResponse: (response: HttpPayload<AccountLoginResponse>, provider: string) => Promise<void>;

package/types/client/userAlerts.d.ts

@@ -0,0 +1,68 @@
+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",
+    Normal = "normal",
+    Suspended = "suspended"
+}
+export declare enum AlertConditionType {
+    Cloudiness = "cloudiness",
+    FreshSnow = "freshSnow",
+    Rainfall = "rainfall",
+    Swell = "swell",
+    Temperature = "temperature",
+    Time = "time",
+    Wind = "wind"
+}
+export declare enum Direction {
+    N = "N",
+    NE = "NE",
+    E = "E",
+    SE = "SE",
+    S = "S",
+    SW = "SW",
+    W = "W",
+    NW = "NW"
+}
+export declare enum Weekday {
+    Monday = "mon",
+    Tuesday = "tue",
+    Wednesday = "wed",
+    Thursday = "thu",
+    Friday = "fri",
+    Saturday = "sat",
+    Sunday = "sun"
+}
+/**
+ * https://www.eoas.ubc.ca/courses/atsc113/flying/met_concepts/01-met_concepts/01c-cloud_coverage/index.html
+ *
+ * Values are meteorological convention.
+ */
+export declare enum CloudCoverage {
+    /** No clouds */
+    SkyClear = "SKC",
+    /** 1/8 to 2/8 cloud cover */
+    Few = "FEW",
+    /** 3/8 to 4/8 cloud cover */
+    Scattered = "SCT",
+    /** 5/8 to 7/8 cloud cover */
+    Broken = "BKN",
+    /** 8/8 cloud cover */
+    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>;
+export declare function updateAlert(data: AlertResponse): Promise<AlertResponse>;
+export declare function deleteAlert(alertId: string): Promise<void>;
+export declare function getNearAlert(location: LatLon): Promise<AlertResponse | undefined>;
+export declare function getNearAlerts(location: LatLon): Promise<AlertResponse[]>;
+export declare function add(latLonAndName: LatLon & {
+    locationName?: string;
+}): void;
+export declare function userHasAnyAlerts(): Promise<boolean>;

package/types/client/userConsent.d.ts

@@ -0,0 +1,6 @@
+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,122 +1,46 @@
-import { Evented } from '@windy/Evented';
-import { Favs } from '@windy/Favs';
-import type { FavKey } from '@windy/Favs';
-import type { Fav, LatLon, SavedFav, Alert } from '@windy/interfaces.d';
-import type { Timestamp } from '@windy/types.d';
-export type AlertCheckResult = {
-    status: 'missing';
-    text: 'Alert not in DB';
-} | {
-    alert: Alert & {
-        suspended: true;
-    };
-} | {
-    status: 'ok';
-    alert: Alert;
-    timestamps: Timestamp[];
-};
-interface FavsTypes {
-    favsChanged: void;
-    alertsChecked: number | void;
-}
-declare class SavedFavs extends Favs<SavedFav> {
-    protected ident: "favs2";
-    private triggeredAlerts;
-    /**
-     * Supported types in this version
-     */
-    private types;
-    private overflowedKey;
-    on: Evented<FavsTypes>['on'];
-    off: Evented<FavsTypes>['off'];
-    emit: Evented<FavsTypes>['emit'];
-    constructor();
-    isValidFavourite(item: Fav): boolean;
-    /**
-     * Check if object is an alert (or near) and have triggered timestamps
-     * item = latLonObj or alert id
-     * returns list of timestamps if triggered
-     */
-    hasTimestamps<T extends LatLon | string>(item: T): number[] | null;
-    /**
-     * Add favorite
-     */
-    add(item: Fav): boolean | Promise<string>;
-    /**
-     * Search for an alert either by id or latLon
-     */
-    getAlert<T extends LatLon | string>(item: T): SavedFav | undefined;
-    /**
-     *
-     * Return favs as array
-     */
-    getArray(deduped?: boolean, editedAlert?: Fav): SavedFav[];
-    isFreeLimitExceeded(editedAlert?: Fav): boolean;
-    /**
-     * Emits info about favs status change
-     */
-    emitChange(): void;
-    /**
-     * Send updated fav to the server
-     */
-    updateFav(fav: Fav): Promise<void>;
-    rename(fav: SavedFav, name: string): Promise<void>;
-    remove(passedItem: Fav | FavKey, isAlert?: boolean): Promise<void>;
-    /**
-     * Check triggering of single alert (always resolve)
-     */
-    checkAlerts(param?: {
-        newlyAddedId: string;
-    }): void;
-    /**
-     * Called upon inserting/deletion Display all favs on a map. This is VERY unefective method
-     * that should keep client code small
-     */
-    onchange(): void;
-    reset(): void;
-    /**
-     * get list of all overflowed deduplicated favs from store
-     */
-    getOverflowed(): SavedFav[];
-    unstoreOverflowed(): void;
-    resetOverflowed(): void;
-    removeOverflowed(fav: Fav): void;
-    /**
-     * start to sync some overflowed
-     */
-    syncOverflowed(fav: Fav): void;
-    /**
-     * Toggle pinning fav to top or to homepage
-     */
-    togglePin(fav: SavedFav, whereToPin: 'pin2top' | 'pin2homepage', forcedTimestamp?: Timestamp): null | undefined | Timestamp;
-    /**
-     * Load from cloud
-     */
-    private loadFromCloud;
-    /**
-     * Alert related methods
-     * item = fav || key
-     */
-    private setAlertProps;
-    private createSyncError;
-    private checkAlert;
-    /**
-     * Alerts were checked
-     */
-    private onAlertsChecked;
-    /**
-     * Check validity and store fav
-     */
-    private checkAndStore;
-    /**
-     * set an object as an overflowed favs if none are set already
-     */
-    private storeOverflowed;
-    /**
-     * add item as overflowed
-     */
-    private addOverflowed;
-    private onUserData;
-}
-declare const _default: SavedFavs;
-export default _default;
+import type { Fav, FavId } from '@windy/favs';
+export declare const emitChange: () => void;
+/**
+ * Adds a fav to the db
+ */
+export declare const add: () => Promise<FavId | null>;
+/**
+ * Update Fav in the db
+ */
+export declare const update: () => Promise<FavId | null>;
+/**
+ * Remove fav from db
+ */
+export declare const remove: () => Promise<void>;
+/**
+ * Toggle pinning fav to top or to homepage
+ */
+export declare const togglePin: () => Promise<void>;
+/**
+ * Find all favs that match given criteria
+ */
+export declare const find: () => Promise<Fav[]>;
+/**
+ * Same as find but always returns only the first match
+ */
+export declare const findOne: () => Promise<Fav | undefined>;
+/**
+ * Returns all favs as array
+ */
+export declare const getAll: () => Promise<Fav[]>;
+/**
+ * Quick check if fav with given ids exists
+ */
+export declare const isFav: () => Promise<boolean>;
+/**
+ * Toggles fav (adds or removes) from db
+ */
+export declare const toggle: () => Promise<boolean>;
+/**
+ * Checks if fav exists
+ */
+export declare const hasKey: () => Promise<boolean>;
+/**
+ * Removes all favs from the device TODO: Call after logging out
+ */
+export declare const removeAllFavsFromDevice: () => Promise<void>;

package/types/client/utils.d.ts

@@ -1,11 +1,10 @@
+import { HttpError } from './errors';
 import type { RegistrationError } from '@capacitor/push-notifications';
-import type { ClientMessage } from '@plugins/offline/offline';
 import type { RGBA } from '@windy/Color.d';
-import type { HttpError } from '@windy/http';
 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 } from '@windy/types.d';
+import type { ExtendedStationType, HTMLString, NumOrNull, Timestamp, ParsedQueryString } from '@windy/types.d';
 /**
  * One minute in ms.
  *
@@ -42,6 +41,10 @@ export declare const num2char: (num: number) => string;
  * @returns Number
  */
 export declare const char2num: (str: string) => number;
+/**
+ * Size of the vector
+ */
+export declare const vec2size: (x: number, y: number) => number;
 /**
  * Takes {lat,lon} and returns nice string out of it (rounds coords to two decimals)
  *
@@ -119,13 +122,17 @@ export declare const radToDeg = 57.2957795;
  * leading edge, instead of the trailing.
  *
  * @param func Function to debounce
- * @param wait Time limit of debouncing
+ * @param wailTill Time limit of debouncing
  * @param immediate Should be function trigger on the leading edge or on the trailing
  * @returns Debounced function
  */
-export declare const debounce: <Args extends unknown[], F extends (...args: Args) => void>(func: (this: ThisParameterType<F>, ...args: Args & Parameters<F>) => void, wait: number, immediate?: boolean) => (this: ThisParameterType<F>, ...args: Args & Parameters<F>) => void;
+export declare const debounce: <Args extends unknown[], F extends (...args: Args) => void>(func: (this: ThisParameterType<F>, ...args: Args & Parameters<F>) => void, waitTill: number, immediate?: boolean) => (this: ThisParameterType<F>, ...args: Args & Parameters<F>) => void;
 /**
- * Retun throttling function
+ * Returns a throttled variant of the input function, using a timer to limit calls of the input function.
+ * If the throttled function is called and the timer is not running, the input function is executed immediatelly and a timer is started.
+ * If the throttled function is called again before the timer runs out, the input function is not executed, but the call arguments are stored
+ * and the input function is called once the timer runs out.
+ * If the throttled function is called multiple times while the timer is running, only the latest call arguments are used once the timer runs out.
  *
  * @param this NOT USED, it is only TS explicit this annotation build-time parameter. Consider it as the first parameter would not exist.
  * @param fn Function to throttle
@@ -164,7 +171,10 @@ export interface WindObject extends DirObject {
  * @param v Vector [u,v]
  * @returns Object { wind, dir }
  */
-export declare const wind2obj: (v: [number, number] | RGBNumValues) => WindObject;
+export declare const wind2obj: ([u, v]: [
+    number,
+    number
+] | RGBNumValues) => WindObject;
 export interface WaveObject extends DirObject {
     period: number;
     size: number;
@@ -175,7 +185,7 @@ export interface WaveObject extends DirObject {
  * @param v Vector [u,v,size]
  * @returns Object { wind, dir, period }
  */
-export declare const wave2obj: (v: RGBNumValues) => WaveObject;
+export declare const wave2obj: ([u, v, size]: RGBNumValues) => WaveObject;
 /**
  * Trush if wx object has valid direction
  *
@@ -210,6 +220,7 @@ export declare const isNear: <T extends LatLon, F extends LatLon>(a: T, b: F) =>
  * @returns Bounded 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
  *
@@ -399,7 +410,6 @@ export declare const sanitizeHTML: (s: string) => string;
  * @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 const sendMessageToServiceWorker: (message: ClientMessage) => void;
 /**
  * Same as scale linear from d3 library except with different params
  * https://d3js.org/d3-scale/linear
@@ -436,3 +446,51 @@ export declare const getLocationOfJsAssets: (location: string) => string;
  * Is valid NumValue
  */
 export declare const isValidNumber: (d: NumOrNull | undefined) => boolean;
+/**
+ * Converts C to K
+ */
+export declare const c2kelvin: (c: number) => number;
+/**
+ * Async version of wait
+ */
+export declare const wait: (t: Timestamp) => Promise<void>;
+/**
+ * Removes accents and diacritics from string
+ * "Crème Brûlée" -> "Creme Brulee"
+ * https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript
+ * TODO: Use Unicode property escapes when widely supported, currently at 94% at caniuse
+ */
+export declare const removeDiacritics: (s: string) => string;
+/**
+ * Capitalizes the first letter of a string.
+ * This differs from the CSS property which capitalizes the first letter of each word.
+ */
+export declare const capitalize: (text: string) => string;
+export declare const parseQueryString: (searchQuery: string | undefined) => ParsedQueryString | undefined;
+export declare const seoLangRegex: RegExp;
+/**
+ * Examples of SEO URLs:
+ *
+ * ## https://www.windy.com/cs/... (case [1])
+ * SEO language, used in @module trans  Must be followed by string
+ *
+ * ## https://www.windy.com/-Name-Whatever-overlay (case [2])
+ * SEO Name of Overlay
+ *
+ * ## https://www.windy.com/-Name-Whatever/... (case [3])
+ * SEO NAME of plugin name, followed by any other string
+ *
+ * Remember that numbers are not allowed at the beginning of the URL, to distinguish
+ * any URL from detail.
+ *
+ */
+export declare const parseSeoUrl: (url: string) => {
+    purl: string;
+    overlay: string;
+};
+/**
+ * Safely URL decoded startup pathname
+ */
+export declare const startupPath: any;
+export declare const generateUuidV4: () => string;
+export declare const getErrorMessage: (error: unknown) => string;

package/types/iconfont.d.ts

@@ -1,6 +1,8 @@
 // !!! Automatically generated file by make/iconfont.ts !!!
 
 export type Iconfont =
+    | '<!-- @echo icon-pictures -->'
+    | '<!-- @echo icon-comment-o -->'
     | '<!-- @echo icon-upload -->'
     | '<!-- @echo icon-long-tap -->'
     | '<!-- @echo icon-moving-cloud -->'
@@ -182,10 +184,16 @@ export type Iconfont =
     | '<!-- @echo icon-crown-king -->'
     | '<!-- @echo icon-tide -->'
     | '<!-- @echo icon-car -->'
+    | '<!-- @echo icon-cloud-lightning-big-plus -->'
     | '<!-- @echo icon-share -->'
     | '<!-- @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-github -->'
     | '<!-- @echo icon-link -->'
     | '<!-- @echo icon-plane-snowflake -->'