@windycom/plugin-devtools 1.0.9 → 3.0.0

package/types/client/userFavs.d.ts

@@ -1,129 +1,47 @@
-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 { FavFragment, Fav, FavId } from '@windy/favs.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;
-    private favsMenuOpened;
-    /**
-     * Supported types in this version
-     */
-    private types;
-    private overflowedKey;
-    latestParams: Fav;
-    on: Evented<FavsTypes>['on'];
-    off: Evented<FavsTypes>['off'];
-    emit: Evented<FavsTypes>['emit'];
-    constructor();
-    isValidFavourite(item: Fav): boolean;
-    /**
-     * Called on detail open or picker move. Always have latest { lat, lon } !!!!
-     */
-    update(params: Fav): void;
-    /**
-     * 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 favourite
-     */
-    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;
-    /**
-     * Updates CSS info
-     */
-    updateCSS(): void;
-    /**
-     * 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;
-    /**
-     * Load from cloud
-     */
-    private loadFromCloud;
-    private debouncedUpdate;
-    /**
-     * 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;
+export declare const emitChange: () => void;
+/**
+ * Adds a fav to the db
+ */
+export declare const add: (item: FavFragment) => Promise<FavId | null>;
+/**
+ * Update Fav in the db
+ */
+export declare const update: (id: FavId, properties2update: Partial<Fav>) => Promise<FavId | null>;
+/**
+ * Remove fav from db
+ */
+export declare const remove: (id: FavId) => Promise<void>;
+/**
+ * Toggle pinning fav to top or to homepage
+ */
+export declare const togglePin: (id: FavId, whereToPin: 'pin2top' | 'pin2homepage', forcedTimestamp?: Timestamp) => Promise<void>;
+/**
+ * Find all favs that match given criteria
+ */
+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: (query: Partial<Fav> | ((f: Fav) => boolean)) => 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: (query: Partial<FavFragment>) => Promise<boolean>;
+/**
+ * Toggles fav (adds or removes) from db
+ */
+export declare const toggle: (query: Partial<FavFragment>, item: FavFragment) => Promise<boolean>;
+/**
+ * Checks if fav exists
+ */
+export declare const hasKey: (key: FavId) => 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 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 { HTMLString, Timestamp, ExtendedStationType } from '@windy/types.d';
+import type { ExtendedStationType, HTMLString, NumOrNull, Timestamp } from '@windy/types.d';
 /**
  * One minute in ms.
  *
@@ -18,6 +17,12 @@ export declare const tsMinute: Timestamp;
  * @type {Timestamp}
  */
 export declare const tsHour: Timestamp;
+/**
+ * One day in ms.
+ *
+ * @type {Timestamp}
+ */
+export declare const tsDay: Timestamp;
 /**
  * Long press time in ms. to be used everywhere
  */
@@ -36,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)
  *
@@ -60,6 +69,10 @@ export declare const emptyFun: () => void;
  * @type {string}
  */
 export declare const emptyGIF = "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///ywAAAAAAQABAAACAUwAOw==";
+/**
+ * Checks if the given object is empty (has no keys).
+ */
+export declare const isEmptyObject: (obj: Record<string, unknown>) => obj is Record<string, never>;
 /**
  * Check if obj is a valid obj contaning lat,lon
  * TODO - it returns true also for string coords, but guarding LatLon with only numbered coords!
@@ -109,11 +122,11 @@ 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
  *
@@ -154,7 +167,7 @@ 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;
@@ -165,7 +178,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
  *
@@ -299,7 +312,7 @@ export declare const qs: (tokensObj: QueryStringSource) => string;
  * Loads .js file by appendig it as script element appended to the <head> section of the page
  *
  * @param  {string} url URL of script to be loaded
- * @param callback Callback to be called on HTML script element
+ * @param callback Callback to be called on HTML script element (WARNING: it is not called on script load)
  * @returns
  */
 export declare const loadScript: (url: string, callback?: (s: HTMLScriptElement) => void) => Promise<void>;
@@ -389,12 +402,11 @@ 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
  * @param Object { domain: [  ], range: [] }
- * @returns Object { get, ivert }
+ * @returns Object { get, invert }
  */
 export declare const scaleLinear: ({ domain, range, clip, }: {
     domain: [number, number];
@@ -421,4 +433,28 @@ export declare const wrapCoords: (tilePoint: TilePoint) => TilePoint;
  * based on target and provided locatio returns URL where to load .js asset
  * @param location
  */
-export declare const getLoacationOfJsAssets: (location: string) => string;
+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;

package/types/iconfont.d.ts

@@ -1,10 +1,7 @@
 // !!! Automatically generated file by make/iconfont.ts !!!
 
 export type Iconfont =
-    | '<!-- @echo icon-share -->'
-    | '<!-- @echo icon-bell-plus -->'
-    | '<!-- @echo icon-x -->'
-    | '<!-- @echo icon-twitter -->'
+    | '<!-- @echo icon-upload -->'
     | '<!-- @echo icon-long-tap -->'
     | '<!-- @echo icon-moving-cloud -->'
     | '<!-- @echo icon-uv -->'
@@ -185,6 +182,11 @@ 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-github -->'
     | '<!-- @echo icon-link -->'
     | '<!-- @echo icon-plane-snowflake -->'