@windycom/plugin-devtools 1.0.4 → 1.0.6

package/types/client/errorLogger.d.ts

@@ -3,7 +3,7 @@
  * Defines global `logError( moduleName, msg, errObj )` for custom err loggin.
  * Licences go here since this is the first minified file
  */
-import type { ErrorPayload } from '@windy/errorLogger.d';
+import type { ErrorPayload } from './d.ts.files/errorLogger.d';
 /**
  * Array of all errors reported to kibana, to show them in debug mode
  * plugin

package/types/client/fetch.d.ts

@@ -7,12 +7,16 @@ interface LatLonStep extends LatLon {
     step?: number;
     interpolate?: boolean;
 }
+/**
+ * @ignore
+ */
 export declare const getReftimeIso: (model: Products) => any;
 /**
  * Returns URL for webcam detail by id
  *
  * @param id Webcam id
  * @returns URL for getting the webcam
+ * @ignore
  */
 export declare const getWebcamDetailUrl: (id: string | number) => string;
 /**
@@ -20,6 +24,7 @@ export declare const getWebcamDetailUrl: (id: string | number) => string;
  *
  * @param latLon Object with `lat` and `lon` properties
  * @returns URL for getting list of webcams nearby lat and lon
+ * @ignore
  */
 export declare const getWebcamsListUrl: <T extends LatLon & {
     limit?: number;
@@ -29,6 +34,7 @@ export declare const getWebcamsListUrl: <T extends LatLon & {
  *
  * @param id Webcam id
  * @returns URL for getting webcam archive
+ * @ignore
  */
 export declare const getWebcamArchiveUrl: (id: string | number, hourly?: boolean) => string;
 /**
@@ -37,6 +43,7 @@ export declare const getWebcamArchiveUrl: (id: string | number, hourly?: boolean
  * @param {string} textQuery search query
  * @param {LatLon} [latLon] circle center coordinates
  * @returns {string} URL for searching webcam views
+ * @ignore
  */
 export declare const getSearchWebcamViewsUrl: (textQuery: string, latLon?: LatLon) => string;
 /**
@@ -44,18 +51,33 @@ export declare const getSearchWebcamViewsUrl: (textQuery: string, latLon?: LatLo
  *
  * @param id Webcam id
  * @returns URL for ping webcam metrics
+ * @ignore
  */
 export declare const getWebcamMetricsUrl: (id: string | number) => string;
 /**
- * Returns URL for getting point forecast
+ * Gets point forecast data for given location
+ *
+ * @param model Forecast model
+ * @param params LalLon of the location and additional parameters
+ * @param source Who is the initiator of this request (name of you plugin)
+ * @param qs Additional query string
+ * @param options Additional HTTP options
+ * @returns Promise with HTTP payload
  */
 export declare const getPointForecastData: <T extends LatLonStep>(model: Products, { lat, lon, step, interpolate }: T, source: string, qs?: string, options?: HttpOptions) => Promise<HttpPayload<WeatherDataPayload<DataHash>>>;
 /**
- * Returns URL for getting meteogram forecast
+ * Gets enhanced point forecast meteogram data for given location
+ * @param model Forecast model
+ * @param params LalLon of the location and additional parameters
+ * @param source Who is the initiator of this request (name of you plugin)
+ * @param qs Additional query string
+ * @param options Additional HTTP options
+ * @returns Promise with HTTP payload
  */
 export declare const getMeteogramForecastData: <T extends LatLonStep>(model: Products, { lat, lon, step }: T, options?: HttpOptions) => Promise<HttpPayload<MeteogramDataPayload>>;
 /**
  * Returns URL for getting archive forecast
+ * @ignore
  */
 export declare const getArchiveForecastData: <T extends LatLon>(model: Products, { lat, lon }: T, source: string, qs?: string, options?: HttpOptions) => Promise<HttpPayload<WeatherDataPayload<DataHash>>>;
 /**
@@ -65,24 +87,29 @@ export declare const getArchiveForecastData: <T extends LatLon>(model: Products,
  * @param frag Mercator frag in {z}/{x}/{y} format
  * @param options HTTP options
  * @returns URL for getting citytile forecast
+ * @ignore
  */
 export declare const getCitytileData: (model: Products, frag: string, options?: HttpOptions) => Promise<HttpPayload<CityForecastData> | null>;
 /**
  * Returns URL for nearest POI items (stations, airQ, ...)
  * @param param0
- * @returns
+ * @returns URL for getting nearest POI items
+ * @ignore
  */
 export declare const getNearestPoiItemsUrl: (type: Pois | 'stations', { lat, lon }: LatLon) => string;
 /**
  * Returns URL for tide forecast
+ * @ignore
  */
 export declare const getTideForecastUrl: <T extends LatLonStep>({ lat, lon }: T) => string;
 /**
  * Returns URL for tide POI
+ * @ignore
  */
 export declare const getTidePoiUrl: (id: string) => string;
 /**
  * Get observations URL
+ * @ignore
  */
 export declare const getObservationsUrl: (type: ExtendedStationType, id: string, daysFrom: number, daysTo?: number) => string;
 export {};

package/types/client/format.d.ts

@@ -3,8 +3,8 @@
  *
  * Various formatting utils based on user language and settings
  */
-import type { DirectionFunction, HowOldOptions, TimeFormatFunction } from '@windy/format.d';
-import type { Timestamp } from '@windy/types';
+import type { DirectionFunction, HowOldOptions, TimeFormatFunction } from './d.ts.files/format.d';
+import type { Timestamp } from './d.ts.files/types';
 /**
  * Returns function for displaying hours (either 12,24h format) on a basis of locale store of a browser
  * US, UK, PH, CA, AU, NZ, IN, EG, SA, CO, PK, MY - AM,PM format

package/types/client/http.d.ts

@@ -1,7 +1,7 @@
 /**
  * HTTP fetch lib using Promises, authorization and lru caching
  */
-import type { HttpOptions, HttpPayload } from '@windy/http.d';
+import type { HttpOptions, HttpPayload } from './d.ts.files/http.d';
 export declare const getURL: (url: string) => string;
 export declare class HttpError extends Error {
     status: number;

package/types/client/notifications.d.ts

@@ -1,7 +1,7 @@
 import { Evented } from '@windy/Evented';
 import * as http from '@windy/http';
-import type { HttpPayload } from '@windy/http.d';
-import type { NotificationInfo } from '@windy/notifications.d';
+import type { HttpPayload } from './d.ts.files/http.d';
+import type { NotificationInfo } from './d.ts.files/notifications.d';
 declare class Notification extends Evented<Notification> {
     data: Record<string, unknown>;
     eventSource: null | EventSource;

package/types/client/plugins.d.ts

@@ -1,3 +1,3 @@
-import type { Plugins } from '@windy/plugins.d';
+import type { Plugins } from './d.ts.files/plugins.d';
 declare const plugins: Plugins;
 export default plugins;

package/types/client/pois.d.ts

@@ -2,7 +2,7 @@
  * @module pois
  * Single purpose of this module is to load `poi-libs` plugin whenever user selects non-empty poi or has/adds alert/favourite
  */
-import type { PoisCheckboxes } from '@windy/pois.d';
+import type { PoisCheckboxes } from './d.ts.files/pois.d';
 /**
  * Config for checkboxes of specified poi
  *

package/types/client/products.d.ts

@@ -1,3 +1,3 @@
-import type { products as Iproducts } from '@windy/products.d';
+import type { products as Iproducts } from './d.ts.files/products.d';
 declare const products: Iproducts;
 export default products;

package/types/client/rootScope.d.ts

@@ -1,6 +1,6 @@
-import type { Iconfont } from '@windy/iconfont';
-import type { Isolines, Pois } from '@windy/rootScope.d';
-import type { LoadedTranslations } from '@windy/trans.d';
+import type { Iconfont } from './d.ts.files/iconfont';
+import type { Isolines, Pois } from './d.ts.files/rootScope.d';
+import type { LoadedTranslations } from './d.ts.files/trans.d';
 /**
  * Version of Windy.com client (as taken from package.json)
  * @ignore
@@ -10,7 +10,7 @@ export declare const version: string;
  * Target
  * @ignore
  */
-export declare const target: "index" | "mobile" | "lib" | "embed2";
+export declare const target: "mobile" | "index" | "lib" | "embed2";
 /**
  * Platform
  * @ignore

package/types/client/singleclick.d.ts

@@ -19,8 +19,8 @@
  * @module singleclick
  */
 import { Evented } from '@windy/Evented';
-import type { PluginIdent } from '@windy/Plugin';
-import type { SingleclickTypes, ListeningPriority } from '@windy/singleclick.d';
+import type { PluginIdent } from './d.ts.files/Plugin';
+import type { SingleclickTypes, ListeningPriority } from './d.ts.files/singleclick.d';
 /**
  * Main singleclick event emitter (instance of class {@link Evented.Evented | Evented }.)
  *

package/types/client/storage.d.ts

@@ -1,3 +1,3 @@
-import type { Storage } from '@windy/storage.d';
+import type { Storage } from './d.ts.files/storage.d';
 declare const _default: Storage;
 export default _default;

package/types/client/store.d.ts

@@ -38,8 +38,8 @@
  * @module store
  */
 import { Evented } from '@windy/Evented';
-import type { DataSpecifications, DataSpecificationsObject } from '@windy/dataSpecifications.d';
-import type { SetReturnType, StoreOptions, StoreTypes } from '@windy/store.d';
+import type { DataSpecifications, DataSpecificationsObject } from './d.ts.files/dataSpecifications.d';
+import type { SetReturnType, StoreOptions, StoreTypes } from './d.ts.files/store.d';
 declare class Store extends Evented<StoreTypes> {
     /**
      * Set default value for given key

package/types/client/tileInterpolator.d.ts

@@ -9,10 +9,10 @@
  * @module tileInterpolator
  */
 import { DataTiler } from '@windy/DataTiler';
-import type { PixelInterpolationFun, CoordsInterpolationFun } from '@windy/tileInterpolator.d';
+import type { PixelInterpolationFun, CoordsInterpolationFun } from './d.ts.files/tileInterpolator.d';
 import type { DataTile } from './dataLoader';
-import type { ExtendedTileParams } from '@windy/DataTiler.d';
-import type { FullRenderParameters } from '@windy/Layer.d';
+import type { ExtendedTileParams } from './d.ts.files/DataTiler.d';
+import type { FullRenderParameters } from './d.ts.files/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;

package/types/client/trans.d.ts

@@ -1,5 +1,5 @@
-import type { SupportedLangFiles, Translations } from '@windy/lang-files.d';
-import type { LoadedTranslations, LoadingOptions, TransFileInfo } from '@windy/trans.d';
+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
@@ -34,7 +34,7 @@ declare const getFile: (filename: string, options?: LoadingOptions) => Promise<T
  * @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>;
+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>;
 /**
  * Replace all `[data-*]` translation tags with proper translation in HTML element. It overrides its innerHTML
  * Supported data suffixes: 'title', 'placeholder', 't', 'afterbegin', 'beforeend', 'tooltipsrc'

package/types/client/user.d.ts

@@ -12,9 +12,9 @@
 /**
  * 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';
+import type { User } from './d.ts.files/dataSpecifications.d';
+import type { HttpPayload } from './d.ts.files/http.d';
+import type { AccountLoginResponse, UserInfo } from './d.ts.files/user.d';
 export declare const isLoggedIn: () => boolean;
 export declare const isPublisher: () => boolean;
 export declare const getInfo: () => User | null;

package/types/client/utils.d.ts

@@ -271,7 +271,7 @@ export declare const getAdjustedNow: (syncTime?: number) => number;
  * @param lang Language code
  * @returns True if language is supported, false otherwise
  */
-export declare const isValidLang: (lang: string) => lang is "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";
+export declare const isValidLang: (lang: string) => lang is "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";
 /**
  * Safely joins server name (without trailing / ) and path
  *