@windycom/plugin-devtools 1.0.2-beta.2 → 1.0.5

package/types/client/d.ts.files/plugins.d.ts

@@ -0,0 +1,132 @@
+import { BottomTagPlugin } from '@windy/BottomTagPlugin';
+import { Plugin } from '@windy/Plugin';
+import { SveltePanePlugin } from '@windy/SveltePanePlugin';
+import { SveltePlugin } from '@windy/SveltePlugin';
+import { TagPlugin } from '@windy/TagPlugin';
+
+export interface BottomTagPlugins {
+    accumulations: BottomTagPlugin<'accumulations'>;
+    radar: BottomTagPlugin<'radar'>;
+    satellite: BottomTagPlugin<'satellite'>;
+    'cap-alerts': BottomTagPlugin<'cap-alerts'>;
+    'day-switcher': BottomTagPlugin<'day-switcher'>;
+
+    // mobile only, not embed
+    'mobile-calendar'?: BottomTagPlugin<'mobile-calendar'>;
+
+    // embed or desktop only
+    'progress-bar'?: BottomTagPlugin<'progress-bar'>;
+}
+
+export interface SveltePanePlugins {
+    favs: SveltePanePlugin<'favs'>;
+    alerts: SveltePanePlugin<'alerts'>;
+    colors: SveltePanePlugin<'colors'>;
+    articles: SveltePanePlugin<'articles'>;
+
+    debug: SveltePanePlugin<'debug'>;
+    hurricanes: SveltePanePlugin<'hurricanes'>;
+    'cap-alert': SveltePanePlugin<'cap-alert'>;
+    login: SveltePanePlugin<'login'>;
+    'delete-info': SveltePanePlugin<'delete-info'>;
+    settings: SveltePanePlugin<'settings'>;
+    sounding: SveltePanePlugin<'sounding'>;
+    radiosonde: SveltePanePlugin<'radiosonde'>;
+    airport: SveltePanePlugin<'airport'>;
+    info: SveltePanePlugin<'info'>;
+
+    webcams: SveltePanePlugin<'webcams'>;
+    'webcams-detail': SveltePanePlugin<'webcams-detail'>;
+    'webcams-add': SveltePanePlugin<'webcams-add'>;
+    'webcams-edit': SveltePanePlugin<'webcams-edit'>;
+    'webcams-remove': SveltePanePlugin<'webcams-remove'>;
+    'webcams-embed': SveltePanePlugin<'webcams-embed'>;
+
+    uploader?: SveltePanePlugin<'uploader'>;
+    'external-plugins'?: SveltePanePlugin<'external-plugins'>;
+}
+
+export interface SveltePlugins {
+    'nearest-webcams': SveltePlugin<'nearest-webcams'>;
+    'nearest-webcams-mobile': SveltePlugin<'nearest-webcams-mobile'>;
+    'nearest-airq': SveltePlugin<'nearest-airq'>;
+    'nearest-stations': SveltePlugin<'nearest-stations'>;
+    share: SveltePlugin<'share'>;
+    multimodel: SveltePlugin<'multimodel'>;
+    subscription: SveltePlugin<'subscription'>;
+    'pending-subscription': SveltePlugin<'pending-subscription'>;
+    'whats-new': SveltePlugin<'whats-new'>;
+    offline: SveltePlugin<'offline'>;
+    detail: SveltePlugin<'detail'>;
+    station: SveltePlugin<'station'>;
+    consent: SveltePlugin<'consent'>;
+    rplanner: SveltePlugin<'rplanner'>;
+    menu: SveltePlugin<'menu'>;
+
+    // Mobile/desktop only plugins
+    distance?: SveltePlugin<'distance'>;
+    'article-publisher'?: SveltePlugin<'article-publisher'>;
+    'beta-test'?: SveltePlugin<'beta-test'>;
+    'watch-faces'?: SveltePlugin<'watch-faces'>;
+    'app-review-dialog'?: SveltePlugin<'app-review-dialog'>;
+    'fav-layers'?: SveltePlugin<'fav-layers'>;
+    'developer-mode'?: SveltePlugin<'developer-mode'>;
+
+    // Used as fake plugin for any other external plugin
+    // basically we are unalble to type each individual external plugin
+    'windy-external-plugin'?: SveltePlugin<'windy-external-plugin'>;
+}
+
+export interface PlainPlugins {
+    'gl-particles': Plugin<'gl-particles'>;
+    'legacy-tile-render': Plugin<'legacy-tile-render'>;
+    particles: Plugin<'particles'>;
+}
+
+export interface TagPlugins {
+    /**
+     * Libraries with possible CSS, that remains opened
+     */
+    'rhpane-top': TagPlugin<'rhpane-top'>;
+    rhbottom: TagPlugin<'rhbottom'>;
+    patch: TagPlugin<'patch'>;
+    'poi-libs': TagPlugin<'poi-libs'>;
+
+    /**
+     * Tag Plugins
+     */
+    'fav-alert-menu': TagPlugin<'fav-alert-menu'>;
+    upload: TagPlugin<'upload'>;
+    screenshot: TagPlugin<'screenshot'>;
+    isolines: TagPlugin<'isolines'>;
+    search: TagPlugin<'search'>;
+
+    // not embed plugins
+    'hp-weather'?: TagPlugin<'hp-weather'>;
+
+    // desktop only plugins
+    contextmenu?: TagPlugin<'contextmenu'>;
+    picker?: TagPlugin<'picker'>;
+    globe?: TagPlugin<'globe'>;
+
+    // mobile only plugins
+    'picker-mobile'?: TagPlugin<'picker-mobile'>;
+    'promo-mobile-intro'?: TagPlugin<'promo-mobile-intro'>;
+    profile?: TagPlugin<'profile'>;
+    'save-password'?: TagPlugin<'save-password'>;
+    browser?: TagPlugin<'browser'>;
+    'map-selector'?: TagPlugin<'map-selector'>;
+}
+
+export interface Plugins
+    extends TagPlugins,
+        SveltePlugins,
+        SveltePanePlugins,
+        PlainPlugins,
+        BottomTagPlugins {}
+
+export interface WindowPlugins
+    extends TagPlugins,
+        SveltePlugins,
+        SveltePanePlugins,
+        BottomTagPlugins {}

package/types/client/d.ts.files/pois.d.ts

@@ -0,0 +1,11 @@
+import type { DataSpecifications } from '@windy/dataSpecifications.d';
+import type { Pois } from '@windy/rootScope.d';
+import type { LoadedTranslations } from '@windy/trans.d';
+
+export type PoisCheckboxeDef = {
+    checkboxTranslation?: keyof LoadedTranslations;
+    checkboxText?: string;
+    bindStore: keyof DataSpecifications;
+};
+
+export type PoisCheckboxes = Record<Pois, PoisCheckboxeDef[]>;

package/types/client/d.ts.files/products.d.ts

@@ -0,0 +1,44 @@
+import { AromeProduct } from '@windy/AromeProduct';
+import { EcmwfAnalysisProduct } from '@windy/EcmwfAnalysisProduct';
+import { EcmwfProduct } from '@windy/EcmwfProduct';
+import { Product } from '@windy/Product';
+import { SatelliteProduct } from '@windy/SatelliteProduct';
+import { Products } from '@windy/rootScope.d';
+
+export type products = Implements<
+    { [P in Products]: Product },
+    {
+        bomAccess: Product;
+        mblue: Product;
+        ecmwf: EcmwfProduct;
+        ecmwfWaves: Product;
+        ecmwfAnalysis: EcmwfAnalysisProduct;
+        cams: Product;
+        camsEu: Product;
+        cmems: Product;
+        gfs: Product;
+        gfsWaves: Product;
+        icon: Product;
+        iconD2: Product;
+        iconEu: Product;
+        iconEuWaves: Product;
+        iconWaves: Product;
+        arome: Product;
+        aromeAntilles: AromeProduct;
+        aromeReunion: AromeProduct;
+        nems: Product;
+        namAlaska: Product;
+        namConus: Product;
+        namHawaii: Product;
+        capAlerts: Product;
+        efi: Product;
+        radar: Product;
+        satellite: SatelliteProduct;
+        hrrrAlaska: Product;
+        hrrrConus: Product;
+        ukv: Product;
+        drought: Product;
+        fireDanger: Product;
+        activeFires: Product;
+    }
+>;

package/types/client/d.ts.files/rootScope.d.ts

@@ -0,0 +1,43 @@
+export type Levels = typeof import('./rootScope').levels[number];
+
+export type Overlays = typeof import('./rootScope').overlays[number];
+
+export type AcTimes = typeof import('./rootScope').acTimes[number];
+
+export type LocalProducts = typeof import('./rootScope').localProducts[number];
+
+export type GlobalProducts = typeof import('./rootScope').globalProducts[number];
+
+export type SeaProducts = typeof import('./rootScope').seaProducts[number];
+
+export type AirQualityProducts = typeof import('./rootScope').airQualityProducts[number];
+
+export type LocalPointProducts = typeof import('./rootScope').localPointProducts[number];
+
+export type GlobalPointProducts = typeof import('./rootScope').globalPointProducts[number];
+
+export type PointProducts = typeof import('./rootScope').pointProducts[number];
+
+export type Products = typeof import('./rootScope').products[number];
+
+export type SupportedLanguages = typeof import('./rootScope').supportedLanguages[number];
+
+export type Pois =
+    | 'favs'
+    | 'cities'
+    | 'wind'
+    | 'temp'
+    | 'precip'
+    | 'metars'
+    | 'radiosonde'
+    | 'cams'
+    | 'pgspots'
+    | 'kitespots'
+    | 'surfspots'
+    | 'tide'
+    | 'radiation'
+    | 'firespots'
+    | 'airq'
+    | 'empty';
+
+export type Isolines = 'off' | 'pressure' | 'gh' | 'temp' | 'deg0';

package/types/client/d.ts.files/satellite.d.ts

@@ -0,0 +1,50 @@
+import type { ISODateString } from '@windy/types.d';
+
+export type ArrayBoundaries = [number, number, number, number];
+
+export interface SatelliteInfo {
+    compositeExtents: ArrayBoundaries;
+    compositeMargins: ArrayBoundaries;
+    dstTime: ISODateString[];
+    extents: ArrayBoundaries;
+    flow: string[];
+    flowQuant: number;
+    flowZoom: number[];
+    lon: number;
+    name: string;
+    priority: number;
+    zoom: number[];
+
+    flowStep: number; // flow step in minutes for normalized flow tiles
+
+    /** dateString "2021-09-09T09:00:00Z" */
+    importStart: string;
+    importEnd: string;
+
+    // time interval for archive
+    minDate: string;
+    maxDate: string;
+}
+
+/**
+ * Info Json as loaded from sat server
+ */
+export interface SatelliteInfoJson {
+    // original content:
+    token: string;
+    satellites: SatelliteInfo[];
+    tMax: number; // IR temperature range in tiles (optional)
+    tMin: number;
+
+    // start/end time sun filter aplied on backend (dateString: "2021-09-09T09:00:00Z")
+    filterStart: string;
+    filterEnd: string;
+
+    // content added during processing:
+    hash: number;
+    minDateTs: number;
+    maxDateTs: number;
+
+    updateTs: number;
+    isArchive: boolean;
+}

package/types/client/d.ts.files/singleclick.d.ts

@@ -0,0 +1,31 @@
+import { LatLon } from '@windy/interfaces.d';
+import { Pois } from '@windy/rootScope.d';
+import { Pixel, ExternalPluginIdent } from '@windy/types.d';
+import { PluginIdent } from '@windy/Plugin';
+
+export interface SingleClickParams extends LatLon {
+    x: Pixel;
+    y: Pixel;
+    source: 'singleclick';
+}
+
+type SingleclickPoiTypes = {
+    [key in `poi-${Pois | 'stations' | 'label'}`]: [HTMLElement];
+};
+
+export type SingleclickPluginTypes = {
+    [key in PluginIdent]: [SingleClickParams];
+};
+
+export type SingleclickEternalPluginTypes = {
+    [key in ExternalPluginIdent]: [SingleClickParams];
+};
+
+export interface SingleclickTypes
+    extends SingleclickPoiTypes,
+        SingleclickPluginTypes,
+        SingleclickEternalPluginTypes {
+    click: [SingleClickParams];
+}
+
+export type ListeningPriority = 'high' | 'low';

package/types/client/d.ts.files/storage.d.ts

@@ -0,0 +1,120 @@
+import { MinifestObject } from '@windy/Calendar.d';
+import { Fav, LastSentDevice, SavedFav, SeenArticle } from '@windy/interfaces.d';
+import { StoredTransFile } from '@windy/trans.d';
+import { Timestamp } from '@windy/types.d';
+
+import LRUCache from './lruCache';
+
+export interface StorageData {
+    /**
+     * Number of hits for every single promo2 id.
+     */
+    promos2?: Record<string, number>;
+
+    /**
+     * Temp value ensures user stayed logged with an old authHash during Cordova -> Capacitor migration
+     */
+    authHash?: string;
+
+    /**
+     * Timestamp of last pushing settings to cloud
+     */
+    storedSettings?: number;
+
+    /**
+     * Timestamp of last pulling settings from cloud
+     */
+    lastSyncableUpdatedItem?: number;
+
+    UUID?: string;
+
+    webGLtest3?: { status: string; ua: string };
+
+    /**
+     * Timestamp when rating dialog was shown last time
+     */
+    rateDialogShown?: Timestamp;
+
+    lastSentDevice?: LastSentDevice;
+
+    /**
+     * Articles, user has seen on particular device
+     */
+    articles?: Record<string, SeenArticle>;
+
+    /**
+     * Airport detail offline cache
+     */
+    'offline/airport'?: ReturnType<LRUCache<string>['toJSON']>;
+
+    /**
+     * Used by dev plugin for plugins development
+     */
+    pluginsDev?: { url: string; consent: boolean };
+
+    version?: string;
+
+    // TODO - centralize all these template strings to the logic directly in their modules
+
+    [key: `settings_${string}_ts`]: Timestamp | null;
+
+    [key: `lang/${string}.json`]: StoredTransFile | null;
+
+    [key: `favs${number}`]: Record<string, SavedFav> | null;
+
+    // TODO - remove this
+    [key: `favs${number}_overflowed`]: Record<string, SavedFav> | null;
+
+    [key: `favs${number}_ts`]: Timestamp | null;
+
+    [key: `recents${number}`]: Record<string, Fav> | null;
+
+    [key: `lastMinifest/${string}`]: MinifestObject | null;
+
+    /**
+     * Other dynamically add storage data
+     */
+    [ident: string]: unknown | null;
+}
+
+export type StorageDataKey = keyof StorageData & string;
+
+export interface Storage {
+    /**
+     * Is storage available or not?
+     */
+    isAvbl: boolean;
+
+    /**
+     * Put items to the storage, using `JSON.strigify` to serialize the data
+     *
+     * @param key Key
+     * @param object object
+     * @returns
+     */
+    put: <T extends StorageDataKey>(key: T, object: StorageData[T]) => void;
+
+    /**
+     * Test existence of an item
+     *
+     * @param key Key
+     * @returns True if key is presented
+     */
+    hasKey: <T extends StorageDataKey>(key: T) => boolean;
+
+    /**
+     * Get item from storage, using `JSON.parse` to deserialize the data
+     *
+     * @param key Key
+     * @returns Data
+     */
+    get: <T extends StorageDataKey>(key: T) => StorageData[T] | null;
+
+    /**
+     * Removes item from a storage
+     *
+     * @param key Key
+     * @returns
+     */
+    remove: <T extends StorageDataKey>(key: T) => void;
+}

package/types/client/d.ts.files/store.d.ts

@@ -0,0 +1,61 @@
+import { Timestamp } from '@windy/types.d';
+import { DataSpecifications } from '@windy/dataSpecifications.d';
+
+/**
+ * Stores which have `asyncSet` function defined
+ */
+export type AsyncStores = 'overlay' | 'product';
+
+/**
+ * Return type of `store.set` method. If `asyncSet` is defined, returned type is Promise<T>, boolean for sync stores.
+ * See store.ts `set` method implementation for more info.
+ */
+export type SetReturnType<T extends keyof DataSpecifications> = T extends AsyncStores
+    ? ReturnType<NonNullable<DataSpecifications[T]['asyncSet']>>
+    : boolean;
+
+/**
+ * Optional options for setter
+ */
+export interface StoreOptions {
+    /**
+     * Identifier of UI element that emitted the change (is bounced back with evented message)
+     */
+    UIident?: string;
+
+    /**
+     * Skip validity check
+     */
+    doNotCheckValidity?: boolean;
+
+    /**
+     * Force change update time
+     */
+    update?: Timestamp;
+
+    /**
+     * Skip saving to cloud
+     */
+    doNotSaveToCloud?: boolean;
+
+    /**
+     * Do not store to localStorage
+     */
+    doNotStore?: boolean;
+
+    /**
+     * Force to change the value, even when is the same as previous
+     */
+    forceChange?: boolean;
+}
+
+type UIIdent = string | undefined;
+
+type UnwrappedDataSpecifications = {
+    [P in keyof DataSpecifications]: [DataSpecifications[P]['def'], UIIdent];
+};
+
+interface StoreTypes extends UnwrappedDataSpecifications {
+    _cloudSync: [];
+    _nativeSync: [string, unknown];
+}

package/types/client/d.ts.files/tileInterpolator.d.ts

@@ -0,0 +1,35 @@
+import { NumValue } from '@windy/types.d';
+import { LatLon } from '@windy/interfaces.d';
+
+/**
+ * Returned values in data RGB channels as tuple [NumValue, NumValue, NumValue]
+ */
+export type RGBNumValues = [NumValue, NumValue, NumValue];
+
+/**
+ * Possible returns from interpolator
+ *
+ * `null`    - out of map
+ *
+ * `NaN`     - no data value
+ *
+ * `-1`      - not suitable renderer
+ *
+ * `[number,number,number]` - computed values
+ */
+export type InterpolatorPossibleReturns = RGBNumValues | null | undefined | number;
+
+/**
+ * Interpolates pixel to tuple weather values from RGB channels
+ */
+export type PixelInterpolationFun = (
+    x: number,
+    y: number,
+    mercXpx?: number, // mercator coords in pixels (needed for radar and satellite)
+    mercYpx?: number,
+) => InterpolatorPossibleReturns;
+
+/**
+ * Interpolates coordinates to tuple weather values from RGB channels
+ */
+export type CoordsInterpolationFun = <T extends LatLon>(latLon: T) => InterpolatorPossibleReturns;

package/types/client/d.ts.files/trans.d.ts

@@ -0,0 +1,55 @@
+import { MainLangFile, PluginTranslations, Translations } from '@windy/lang-files.d';
+
+import type { Overlays } from '@windy/rootScope.d';
+
+/**
+ * test loaded file, if everything was correct
+ *
+ * Key 'waves' is used in productsLang.js, since we use IDs of
+ * overlays
+ */
+export type ValidTranslationKey = keyof Translations | Overlays;
+
+export interface TransFileInfo {
+    /**
+     * Which lang file is loaded to client
+     */
+    loaded?: string;
+
+    /**
+     * Relative URL of file
+     */
+    filename: string;
+
+    /**
+     * test loaded file, if everything was correct
+     */
+    test: ValidTranslationKey;
+}
+
+export interface StoredTransFile {
+    /**
+     * All translations in a key-value pairs
+     */
+    data: Translations;
+
+    /**
+     * Client version
+     */
+    version: string;
+}
+
+export interface LoadingOptions {
+    /**
+     * Absolute URL to load lang file from (handy in client patch for example)
+     */
+    absoluteURL?: string | boolean;
+
+    /**
+     * Optional test string, that can overload standard test string
+     */
+    test?: ValidTranslationKey;
+}
+
+// TODO - there must be better solution how to reflect keys for files and let plugin keys mandatory for loaded files
+export type LoadedTranslations = MainLangFile & PluginTranslations;

package/types/client/d.ts.files/user.d.ts

@@ -0,0 +1,58 @@
+import { SubscriptionInfo } from '@plugins/_shared/subscription-services/subscription-services.d';
+import { User } from '@windy/dataSpecifications.d';
+import { SubTier } from '@windy/types.d';
+
+/**
+ * user info as it's returned from account or node users
+ */
+export interface UserInfo {
+    /**
+     * true if user is authenticated
+     */
+    auth?: boolean;
+
+    /**
+     * aka userToken in storage
+     */
+    token?: string;
+
+    /**
+     * @deprecated
+     * tier level of user premium - TODO remove
+     */
+    subscription?: SubTier;
+
+    /** Detail info about subscription. It is undefined if no subscription is available for the user. */
+    subscriptionInfo?: SubscriptionInfo;
+
+    /**
+     * user as in storage definition
+     */
+    userInfo?: User;
+}
+
+/**
+ * @typedef {Object} LoginResponse login response as it's returned from account or node login
+ * @property {string} message custom message to be used in errors (or 'ok' if no error)
+ * @property {string} authHash as in storage definition
+ */
+
+/**
+ * login response as it's returned from account or node login
+ */
+export interface AccountLoginResponse {
+    /**
+     * custom message to be used in errors (or 'ok' if no error)
+     */
+    message: string;
+
+    /**
+     * userInfo as information to be stored
+     */
+    userInfo: UserInfo;
+
+    /**
+     * authHash as in storage definition
+     */
+    authHash: string;
+}

package/types/{dataSpecifications.d.ts → client/dataSpecifications.d.ts}

@@ -4,7 +4,7 @@
  *
  * @module dataSpecifications
  */
-import type { DataSpecifications } from '@windy/dataSpecifications.d';
+import type { DataSpecifications } from './d.ts.files/dataSpecifications.d';
 /**
  * Mother of all settings. All the user setting (except for large data structures) should go here
  */

package/types/client/debugPremiumIssues.d.ts

@@ -0,0 +1,22 @@
+declare const _default: {
+    status: number;
+    data: {
+        auth: boolean;
+        token: string;
+        userInfo: {
+            id: number;
+            username: string;
+            userslug: string;
+        };
+        subscriptionInfo: {
+            tier: string;
+            status: string;
+            platform: string;
+            state: string;
+            expiresAt: number;
+            isSubscription: boolean;
+            isTrial: boolean;
+        };
+    };
+};
+export default _default;