@windycom/plugin-devtools 1.0.4 → 1.0.6

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

@@ -0,0 +1,35 @@
+import type { HttpError } from '@windy/http';
+
+/** Payload sent to backend */
+export interface ErrorPayload {
+    timestamp: number;
+    runningMs: number;
+    type: string;
+    module: string | null | undefined;
+    msg: string;
+    line: number | null | undefined;
+    col: number | null | undefined;
+    url: string | undefined;
+    script: string | null | undefined;
+    ver: string;
+    target: string;
+    stack: string | undefined;
+    error: string;
+    isOnline: boolean;
+    repeated?: number;
+    scriptLine?: string;
+    latestBcast?: string;
+    sessionName?: string;
+    sessionCounter?: number;
+    lang?: string;
+    size?: string;
+    platform?: string;
+    errorID?: string;
+    beta?: boolean;
+}
+
+export interface CustomError {
+    msg: string;
+    moduleName: string;
+    errorObject?: Error | HttpError | Event | ErrorEvent;
+}

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

@@ -0,0 +1,48 @@
+import { Timestamp } from '@windy/types.d';
+
+export type TimeFormatFunction = (hour: number, min?: number) => string;
+
+export type DirectionFunction = (dir: number | string) => string;
+
+// at lease one of them is required, that is why it is an interface intersection and union
+export type HowOldOptions = (
+    | {
+          /**
+           * Already calculated time difference in minutes (optional)
+           */
+          diffMin: number;
+      }
+    | {
+          /**
+           * Timestamp
+           */
+          ts: Timestamp;
+      }
+    | {
+          /**
+           * Timestamp in minutes (who the FUCK uses this?)
+           */
+          min: number;
+      }
+    | {
+          /**
+           * UNIX timestamp
+           */
+          ux: number;
+      }
+) & {
+    /**
+     * Should we localize output?
+     */
+    translate?: boolean;
+
+    /**
+     * Use 'ago' string for output
+     */
+    useAgo?: boolean;
+
+    /**
+     * (default: true) Future timestamps are displayed with `in ...`. If false, `now` string is used instead
+     */
+    useFuture?: boolean;
+};

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

@@ -0,0 +1,87 @@
+import { Timestamp } from '@windy/types.d';
+
+export type QueryStringSource = Record<
+    string | number,
+    string | number | undefined | null | boolean
+>;
+
+/**
+ * Options for http requests
+ */
+export interface HttpOptions {
+    /**
+     * Signal from `AbortController` used to abort the request.
+     */
+    abortSignal?: AbortSignal;
+
+    /**
+     * Query string as object of 🔐 value pairs
+     */
+    qs?: QueryStringSource;
+
+    /**
+     * By default all responses are considered JSON and parsed
+     * Use binary option to fetch data via arrayBuffer and use it as binary data
+     */
+    binary?: boolean;
+
+    /**
+     * Should we use out internal LRU cache (default true)
+     */
+    cache?: boolean;
+
+    /**
+     * Always treat http response as JSON
+     */
+    json?: boolean;
+
+    /**
+     * Any object to be sent via POST method
+     */
+    data?: unknown;
+
+    /**
+     * Add login credentials/cookies or preflight request
+     */
+    withCredentials?: boolean;
+
+    /**
+     * TTL of cache object (in ms)
+     */
+    ttl?: Timestamp;
+
+    /**
+     * Request timeout (in ms)
+     */
+    timeout?: Timestamp;
+
+    /**
+     * Custom headers object
+     */
+    customHeaders?: Record<string, string>;
+}
+
+/**
+ * Standard result payload
+ */
+export interface HttpPayload<T> {
+    /**
+     * Status code
+     */
+    status: number;
+
+    /**
+     * Is the response JSON? Internal flag for caching purpose, do not use
+     */
+    isJSON?: boolean;
+
+    /**
+     * Expiration time. Internal value for caching purpose.
+     */
+    expire?: Timestamp;
+
+    /**
+     * Payload.
+     */
+    data: T;
+}

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

@@ -0,0 +1,88 @@
+/**
+ * Keep this file in-sync with outgoingMessages in the embed repo.
+ */
+
+import type { MetricItem } from '@windy/Metric.d';
+import type { Levels, Overlays, Products } from '@windy/rootScope.d';
+
+/**
+ * Values parsed from the query string.
+ */
+export interface QueryStringEmbedParams {
+    /**
+     * @deprecated Deleted from the embed config (2023-09-20).
+     */
+    calendar: string;
+    detailLat: number;
+    detailLon: number;
+    embedMake: boolean;
+    /**
+     * @deprecated Not sent from the old embed config.
+     */
+    forecast?: string;
+    /**
+     * @deprecated Menu constantly shown in the old embed config.
+     */
+    hideMenu: boolean;
+    hideMessage: boolean;
+    /**
+     * Used in `rootScope.ts`.
+     */
+    lang?: string;
+    lat: number;
+    /**
+     * @deprecated Currently not sent from the embed config (2023-09-20).
+     */
+    level?: Levels;
+    lon: number;
+    /**
+     * @deprecated Location constantly set to `coordinates` in the old embed config.
+     */
+    location: string;
+    metricRain?: MetricItem;
+    metricTemp?: MetricItem;
+    metricWind?: MetricItem;
+    /**
+     * @deprecated Currently not sent from the embed config (2023-09-20).
+     */
+    overlay?: Overlays;
+    pressure: boolean;
+    /**
+     * @deprecated Currently not sent from the embed config (2023-09-20).
+     */
+    product?: Products;
+    showDetail: boolean;
+    showMarker: boolean;
+    /**
+     * @deprecated Only used for query string of type=alert
+     */
+    timestamps?: string;
+    type: 'map' | 'alert' | 'forecast';
+    zoom: number;
+}
+
+/**
+ * Values received from the embed config via window.onMessage.
+ * Subset of {@link QueryStringEmbedParams} with support for default units.
+ */
+export interface UpdateEmbedPayload {
+    detailLat: number;
+    detailLon: number;
+    hideMessage: boolean;
+    metricRain: QueryStringEmbedParams['metricRain'] | 'default';
+    metricTemp: QueryStringEmbedParams['metricTemp'] | 'default';
+    metricWind: QueryStringEmbedParams['metricWind'] | 'default';
+    pressure: boolean;
+    showDetail: boolean;
+    showMarker: boolean;
+}
+
+export interface UpdateEmbedMessageData {
+    type: 'updateEmbed';
+    payload: UpdateEmbedPayload;
+}
+
+/**
+ * Message data that is possible to receive via `window.onMessage`.
+ */
+export type IncomingMessageData = UpdateEmbedMessageData | unknown;

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

@@ -0,0 +1,74 @@
+/* eslint-disable */
+// @ts-ignore
+// @ts-nocheck
+
+import type { DataSpecifications } from '@windy/dataSpecifications.d';
+import type { LatLon } from '@windy/interfaces';
+import type { PluginsOpenParams } from '@windy/plugin-params';
+
+export type LibHtml = string;
+
+type AllowedDataSpecifications = Pick<
+    DataSpecifications,
+    | 'overlay'
+    | 'level'
+    | 'particles'
+    | 'numDirection'
+    | 'lang'
+    | 'disableWebGL'
+    | 'graticule'
+    | 'particlesAnim'
+    | 'timestamp'
+    | 'isolines'
+    | 'isImperial'
+    | 'latlon'
+    | 'hourFormat'
+    | 'favOverlays'
+    | 'expertMode'
+    | 'product'
+>;
+export type WindyAPIOptions = Partial<{
+    [P in keyof AllowedDataSpecifications]: AllowedDataSpecifications[P]['def'];
+}>;
+
+export interface InitOptions extends WindyAPIOptions {
+    key?: string;
+    verbose?: boolean;
+
+    lat?: number;
+    lon?: number;
+    lng?: number;
+    zoom?: number;
+}
+
+type ApiPicker =
+    | typeof import('@windy/picker') & {
+          open: (latLon: LatLon) => void;
+          close: () => void;
+          getParams: () => PluginsOpenParams['picker'];
+      };
+
+export type InitCb = (windyAPI: {
+    map: WModules['map']['map'];
+    store: WModules['store'];
+    picker: ApiPicker;
+    utils: WModules['utils'];
+    broadcast: WModules['broadcast'];
+    overlays: WModules['overlays'];
+    colors: WModules['colors'];
+}) => void;
+
+export interface ApiAuthResponse {
+    domains: string;
+    paid: boolean;
+    apiUser: string;
+    id: string;
+    name: string;
+    type: string;
+    exceeded: boolean;
+    auth: string;
+    features: {
+        intersucho?: boolean;
+        ecmwf?: boolean;
+    };
+}

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

@@ -0,0 +1,39 @@
+import { QueryStringSource } from '@windy/http.d';
+
+export interface NotifHttpQsOptions extends QueryStringSource {
+    pageSize: number;
+    current: number;
+    markAsViewed?: boolean;
+}
+
+export interface DeliveryInfo {
+    deviceID: string;
+    platform: string;
+    type: string;
+}
+
+export interface NotificationObject {
+    created: number;
+    delivery: DeliveryInfo[];
+    other: {
+        fav: string;
+        firstTimestamp: number;
+    };
+    type: string;
+    updated: number;
+    userID: string;
+    wasReceived: boolean;
+    wasViewed: boolean;
+    _id: string;
+}
+
+export interface NotificationInfo {
+    totalCount: number;
+    newNotifications: unknown;
+    newCount: number;
+    data: NotificationObject[];
+}
+
+export interface NotificationTypes {
+    canReceiveNotif: void;
+}

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

@@ -0,0 +1,75 @@
+/**
+ * Keep this file in-sync with incomingMessages in the embed repo.
+ */
+
+import type { MetricItem } from '@windy/Metric.d';
+import type { LatLon } from '../../types/interfaces';
+
+/**
+ * Types of valid messages sent to the embed config via window.postMessage.
+ */
+export type OutgoingMessageType = 'updateDetail' | 'updateValues';
+
+/**
+ * Payload of the updateDetail message.
+ */
+export interface UpdateDetailPayload {
+    coordinates: LatLon;
+    rainUnit: MetricItem;
+    showDetail: boolean;
+    showMarker: boolean;
+    temperatureUnit: MetricItem;
+    windUnit: MetricItem;
+}
+
+/**
+ * Payload of the updateValues message.
+ */
+export interface UpdateValuesPayload {
+    /**
+     * Coordinates.
+     */
+    coordinates: LatLon;
+
+    /**
+     * Level.
+     */
+    level: string;
+
+    /**
+     * User-friendly text of the level value.
+     */
+    levelText: string;
+
+    /**
+     * Overlay identifier.
+     */
+    overlay: string;
+
+    /**
+     * Overlay name.
+     */
+    overlayName: string;
+
+    /**
+     * Product identifier.
+     */
+    product: string;
+
+    /**
+     * Product name.
+     */
+    productName: string;
+
+    /**
+     * Zoom level.
+     */
+    zoom: number;
+}
+
+/**
+ * Valid message data sent to the embed config via window.postMessage.
+ */
+export type OutgoingMessageData =
+    | { type: 'updateDetail'; payload: Partial<UpdateDetailPayload> }
+    | { type: 'updateValues'; payload: UpdateValuesPayload };

package/types/client/d.ts.files/plugin-params.d.ts

@@ -0,0 +1,236 @@
+import { OpenOptions } from '@capacitor/browser';
+import { PublicationParams } from '@plugins/articles/articles.d';
+import { FavEventTypes } from '@plugins/favs/favs.d';
+import { ProviderConstructorParams } from '@plugins/_shared/subscription-services/subscription-services.d';
+import { HiddenReasonType, ReasonTypes } from '@plugins/subscription/subscription';
+import { FullRenderParameters } from '@windy/Layer.d';
+import { WebcamCategoryType } from '@windy/Webcams.d';
+import { HttpPayload } from '@windy/http.d';
+import {
+    CapAlertHeadline,
+    GeolocationInfo,
+    HomeLocation,
+    LatLon,
+    PickerCoords,
+    SavedAlertFav,
+    SavedFav,
+    SummaryDataHash,
+    WeatherDataPayload,
+} from '@windy/interfaces.d';
+import { Pois, Products } from '@windy/rootScope.d';
+import { SingleClickParams } from '@windy/singleclick.d';
+import {
+    DetailDisplayType,
+    RouteType,
+    StationOrPoiType,
+    type ExternalPluginIdent,
+} from '@windy/types.d';
+
+/**
+ * Type of source event, that led to opening any plugin
+ */
+export type PluginOpenEventSource =
+    | 'contextmenu'
+    | 'hp'
+    | 'url'
+    | 'sigleclick'
+    | 'poi-icon'
+    | 'search'
+    | 'detail'
+    | 'singleclick'
+    | 'favs-page'
+    | 'picker'
+    | 'meta'
+    | 'fallback'
+    | 'gps'
+    | 'ip'
+    | 'uploader'
+    | 'api'
+    | 'last'
+    | 'back-button'
+    | 'label';
+
+export interface PluginSource {
+    source?: PluginOpenEventSource;
+    poiType?: StationOrPoiType | Pois | 'stations';
+}
+
+interface DetailOpenParams extends PluginSource, LatLon {
+    /**
+     * How to display detail
+     */
+    display?: DetailDisplayType;
+
+    /**
+     * Product to open
+     */
+    product?: Products;
+
+    /**
+     * Name of locality
+     */
+    name?: string;
+
+    /**
+     * ID of POI icon that was clicked to open detail
+     */
+    id?: string;
+
+    /**
+     * If detail is opened by clicking on label
+     */
+    sourceEl?: HTMLElement;
+
+    /**
+     * Detail was opened by clicking on Alert neotification so detail table should be scrolled to
+     * particular timestamp
+     */
+    moveToTimestamp?: boolean;
+
+    /**
+     * Array of times, when Alert was triggered in a form of 897987987,098908089,09809098
+     * where numbers are timestamps / tsHour
+     */
+    hrTimestamps?: string;
+}
+
+type WebcamDetailOpenParams =
+    | (PluginSource & {
+          id: number | string;
+      })
+    | undefined;
+
+type RplannerDistanceParams =
+    | { view?: RouteType; coords: string; id?: string } // Opening from URL
+    | SavedFav
+    // | RplannerOpeningAsFavs // Clicking on route stored as fav
+    | LatLon[] // User puts two airports is search bar
+    | (LatLon & {
+          source: 'contextmenu';
+      }) // Click with RH mouse and activate from contextmenu
+    | {
+          import: boolean;
+          content: string;
+      }; // Uploaded GPX
+
+export type PickerOpenParams =
+    | (PluginSource &
+          PickerCoords & {
+              noEmit?: boolean;
+          })
+    | SingleClickParams;
+
+export type PluginsOpenParams = {
+    detail: DetailOpenParams;
+    picker: PickerOpenParams;
+    'picker-mobile': PickerOpenParams;
+    favs:
+        | (PluginSource & {
+              msg?: FavEventTypes;
+          })
+        | undefined;
+
+    station: PluginSource & { id?: string; stationId?: string };
+    multimodel: LatLon & PluginSource & { name?: string | null };
+    webcams: (PluginSource & { category: WebcamCategoryType }) | undefined;
+    'webcams-detail': PluginSource & WebcamDetailOpenParams;
+    'webcams-edit': PluginSource & WebcamDetailOpenParams;
+    'webcams-embed':
+        | PluginSource & {
+              id: string | number;
+              forcedPois?: boolean;
+          };
+    'webcams-remove': PluginSource & WebcamDetailOpenParams;
+    //settings: (PluginSource & { id: string }) | undefined;
+    settings: (PluginSource & { section?: 'notificationPreferences' }) | undefined;
+    articles: (PluginSource & { id: number }) | (PluginSource & PublicationParams) | undefined;
+    'article-publisher': (PluginSource & { pane?: '' | 'list' | 'detail' }) | null;
+    upload: PluginSource & { id: string };
+    uploader: PluginSource & { id?: string };
+    'cap-alert': PluginSource &
+        LatLon & {
+            /**
+             * Name of locality
+             */
+            name?: string;
+        };
+    contextmenu: PluginSource & LatLon & { containerPoint?: L.Point };
+    subscription:
+        | (PluginSource & {
+              fscNext?: string;
+              promote?: ReasonTypes | HiddenReasonType;
+              pendingError?: Error & { responseText: string };
+          })
+        | undefined;
+    alerts:
+        | (PluginSource & {
+              id?: string;
+              name?: string;
+              title?: string;
+              action?: 'new';
+              lat?: string | number;
+              lon?: string | number;
+          })
+        | (PluginSource & SavedAlertFav);
+    distance: PluginSource & RplannerDistanceParams;
+    rplanner: PluginSource & RplannerDistanceParams;
+    airport: PluginSource & {
+        // Airport plugin can receive ICAO code as id || icao property
+        icao?: string;
+        id?: string;
+    };
+    'save-password': PluginSource & {
+        username: string;
+        password: string;
+    };
+    share: undefined;
+    'nearest-stations': PluginSource & LatLon & { compactVersion?: boolean; includeAirq?: boolean };
+    'nearest-airq': PluginSource & LatLon;
+    'nearest-webcams-mobile': PluginSource & LatLon;
+    'nearest-webcams': PluginSource & LatLon;
+    'external-plugins':
+        | (PluginSource & { id?: string; qs?: PluginsQsParams['external-plugins'] })
+        | undefined;
+    browser: PluginSource & {
+        options: OpenOptions;
+        onFinished?: () => void;
+    };
+    sounding: PluginSource & LatLon & { name?: string };
+    radiosonde: PluginSource & { id: string; lat?: number; lon?: number };
+    'hp-weather': PluginSource & {
+        coords: HomeLocation | GeolocationInfo;
+        promises: {
+            wx: Promise<HttpPayload<WeatherDataPayload<SummaryDataHash>>>;
+            capAlerts: Promise<HttpPayload<CapAlertHeadline[]>>;
+        };
+    };
+    login:
+        | (PluginSource & {
+              reason?: 'login' | 'register';
+          })
+        | undefined;
+    isolines: PluginSource & FullRenderParameters;
+    screenshot: (PluginSource & { params?: string }) | undefined;
+    hurricanes: (PluginSource & { id: string }) | undefined;
+    'app-review-dialog':
+        | (PluginSource & {
+              sessionsPerDay?: number;
+              showSystemDialog?: boolean;
+          })
+        | undefined;
+    offline: PluginSource;
+    'developer-mode': (PluginSource & { qs: Record<string, string> | undefined }) | undefined;
+    'windy-external-plugin': PluginSource & LatLon;
+} & {
+    [external: ExternalPluginIdent]:
+        | (PluginSource & { query: Record<string, string> | undefined })
+        | (PluginSource & LatLon)
+        | undefined;
+} & { [others: string]: undefined };
+
+export type PluginsQsParams = {
+    subscription: ProviderConstructorParams | undefined;
+    'external-plugins': Record<string, string> | undefined;
+    'developer-mode': Record<string, string> | undefined;
+    detail: { hrTimestamps?: string; name?: string; moveToTimestamp?: string };
+} & { [others: string]: undefined };