@windycom/plugin-devtools 1.0.4 → 1.0.6

package/README.md

@@ -4,4 +4,6 @@ Check out https://docs.windy-plugins.com for more information.
 
 # CHANGELOG
 
--   1.X.X - TS declarations for client v42
+-   1.0.6 - Fix plugin version validation
+-   1.0.5 - Fixing .d.ts declarations
+-   1.0.0 - TS declarations for client v42

package/index.mjs

@@ -3,6 +3,7 @@ import fs from 'fs';
 import assert from 'assert';
 import MagicString from 'magic-string';
 import { walk } from 'estree-walker';
+const semver = require('semver');
 
 const testLoadedPlugin = config => {
     const { name, version, title, desktopUI, mobileUI, routerPath, icon } = config;
@@ -13,8 +14,8 @@ const testLoadedPlugin = config => {
     );
 
     assert(
-        typeof version === 'string' && version.match(/^\d+\.\d+\.\d+$/),
-        'Plugin version is not defined or is not in semversion format (example: 1.3.7)',
+        typeof version === 'string' && semver.valid(version),
+        'Plugin version is not defined or is not in SemVer format (example: 1.3.7)',
     );
 
     assert(

package/package.json

@@ -1,9 +1,12 @@
 {
     "name": "@windycom/plugin-devtools",
-    "version": "1.0.4",
+    "version": "1.0.6",
     "description": "Developer tools and TS declarations for developers of Windy Plugins.",
     "main": "index.mjs",
     "module": "index.mjs",
     "author": "Windyty, S.E.",
-    "license": "ISC"
+    "license": "ISC",
+    "dependencies": {
+        "semver": "^7.6.0"
+    }
 }

package/types/client/Calendar.d.ts

@@ -1,10 +1,10 @@
 /**
  * Object containing timestamps and methods for given weather product
  */
-import type { CalendarDay, MinifestObject, Weekday } from '@windy/Calendar.d';
-import type { TimeFormatFunction } from '@windy/format.d';
-import type { Products } from '@windy/rootScope.d';
-import type { ISODateString, Path, Timestamp } from '@windy/types.d';
+import type { CalendarDay, MinifestObject, Weekday } from './d.ts.files/Calendar.d';
+import type { TimeFormatFunction } from './d.ts.files/format.d';
+import type { Products } from './d.ts.files/rootScope.d';
+import type { ISODateString, Path, Timestamp } from './d.ts.files/types.d';
 export type CalendarInitParams = Pick<Calendar, 'numOfHours' | 'minifestFile'> & {
     /**
      * Ident of product that this calendar is for

package/types/client/Color.d.ts

@@ -1,6 +1,6 @@
-import type { ColorGradient, ColorIdent, PluginColorIdent, RGBA, RGBString } from '@windy/Color.d';
-import type { StoreOptions } from '@windy/store.d';
-import type { NumValue } from '@windy/types.d';
+import type { ColorGradient, ColorIdent, PluginColorIdent, RGBA, RGBString } from './d.ts.files/Color.d';
+import type { StoreOptions } from './d.ts.files/store.d';
+import type { NumValue } from './d.ts.files/types.d';
 export type ColorInitParams = Pick<Color, 'ident'> & Partial<Pick<Color, 'qualitative' | 'save'>> & {
     steps: number;
     default?: ColorGradient | null;

package/types/client/DataTiler.d.ts

@@ -1,6 +1,6 @@
 import { dataLoader } from '@windy/dataLoader';
-import type { FullRenderParameters } from '@windy/Layer.d';
-import type { DataTile } from '@windy/dataLoader';
+import type { FullRenderParameters } from './d.ts.files/Layer.d';
+import type { DataTile } from './d.ts.files/dataLoader';
 import type { ExtendedTileParams } from './DataTiler.d';
 export interface TilePoint {
     x: number;

package/types/client/GlObj.d.ts

@@ -1,4 +1,4 @@
-import type { Canvas, ExtendedWebGLTexture, WebGLProgramObject } from '@windy/GlObj.d';
+import type { Canvas, ExtendedWebGLTexture, WebGLProgramObject } from './d.ts.files/GlObj.d';
 /**
  * GLObj - Web GL context wrapper
  */

package/types/client/Layer.d.ts

@@ -1,14 +1,14 @@
-import type { Color } from '@windy/Color';
-import type { FullRenderParameters, Layers, RenderParams, TransformFunction } from '@windy/Layer.d';
-import type { Metric } from '@windy/Metric';
-import type { Legend } from '@windy/Metric.d';
-import type { NumberedMetric } from '@windy/MetricClasses';
-import type { Product } from '@windy/Product';
-import type { DataQuality, FileSuffix } from '@windy/Product.d';
-import type { Renderers } from '@windy/Renderer.d';
-import type { WeatherParameters } from '@windy/interfaces.d';
-import type { Levels, Products } from '@windy/rootScope.d';
-import type { Timestamp } from '@windy/types';
+import type { Color } from './d.ts.files/Color';
+import type { FullRenderParameters, Layers, RenderParams, TransformFunction } from './d.ts.files/Layer.d';
+import type { Metric } from './d.ts.files/Metric';
+import type { Legend } from './d.ts.files/Metric.d';
+import type { NumberedMetric } from './d.ts.files/MetricClasses';
+import type { Product } from './d.ts.files/Product';
+import type { DataQuality, FileSuffix } from './d.ts.files/Product.d';
+import type { Renderers } from './d.ts.files/Renderer.d';
+import type { WeatherParameters } from './d.ts.files/interfaces.d';
+import type { Levels, Products } from './d.ts.files/rootScope.d';
+import type { Timestamp } from './d.ts.files/types';
 type LayerInitParams = Pick<Layer, 'ident'> & Partial<Layer>;
 export declare class Layer<M extends Metric | undefined = Metric | undefined> {
     /**

package/types/client/Metric.d.ts

@@ -1,8 +1,8 @@
-import type { Color } from '@windy/Color';
-import type { RGBString } from '@windy/Color.d';
-import type { ConvObj, Legend, LegendDescription, LegendLines, MetricIdent, MetricInitParams, MetricItem, MetricKey } from '@windy/Metric.d';
-import type { LoadedTranslations } from '@windy/trans.d';
-import type { HTMLString, NumValue } from '@windy/types.d';
+import type { Color } from './d.ts.files/Color';
+import type { RGBString } from './d.ts.files/Color.d';
+import type { ConvObj, Legend, LegendDescription, LegendLines, MetricIdent, MetricInitParams, MetricItem, MetricKey } from './d.ts.files/Metric.d';
+import type { LoadedTranslations } from './d.ts.files/trans.d';
+import type { HTMLString, NumValue } from './d.ts.files/types.d';
 export declare const rtrnSelf: (x: NumValue) => NumValue;
 /**
  * # @windy/Metric

package/types/client/Product.d.ts

@@ -1,11 +1,11 @@
 import { Calendar } from '@windy/Calendar';
 import * as http from '@windy/http';
-import type { MinifestObject } from '@windy/Calendar.d';
-import type { Layers } from '@windy/Layer.d';
-import type { DataQuality, FileSuffix } from '@windy/Product.d';
-import type { LatLon } from '@windy/interfaces';
-import type { AcTimes, Isolines, Levels, Overlays, Products } from '@windy/rootScope.d';
-import type { ProductCategory, ProductIdent } from '@windy/types';
+import type { MinifestObject } from './d.ts.files/Calendar.d';
+import type { Layers } from './d.ts.files/Layer.d';
+import type { DataQuality, FileSuffix } from './d.ts.files/Product.d';
+import type { LatLon } from './d.ts.files/interfaces';
+import type { AcTimes, Isolines, Levels, Overlays, Products } from './d.ts.files/rootScope.d';
+import type { ProductCategory, ProductIdent } from './d.ts.files/types';
 export type ProductInitParams = Pick<Product, 'modelName' | 'provider' | 'interval'> & Partial<Pick<Product, 'provider' | 'ident' | 'maxTileZoom' | 'animationSpeed' | 'animationSpeed1h' | 'fileSuffix' | 'fileSuffixFallback' | 'JPGtransparency' | 'PNGtransparency' | 'dataQuality' | 'betterDataQuality' | 'animation' | 'labelsTemp' | 'overlays' | 'prefferedProduct' | 'pathGenerator' | 'isolines' | 'directory' | 'category' | 'modelIdent' | 'intervalPremium' | 'server' | 'modelResolution' | 'levels' | 'logo' | 'acTimes'>> & {
     requiresInfoJson?: boolean;
     forecastSize?: number;

package/types/client/Renderer.d.ts

@@ -1,7 +1,7 @@
-import type { FullRenderParameters } from '@windy/Layer.d';
-import type { Renderers } from '@windy/Renderer.d';
-import type { InterpolatorFactory } from '@windy/interpolator';
-import type { BottomTagPlugins, Plugins } from '@windy/plugins.d';
+import type { FullRenderParameters } from './d.ts.files/Layer.d';
+import type { Renderers } from './d.ts.files/Renderer.d';
+import type { InterpolatorFactory } from './d.ts.files/interpolator';
+import type { BottomTagPlugins, Plugins } from './d.ts.files/plugins.d';
 type AllowedRenderPlugins = Pick<Plugins, 'radar' | 'satellite' | 'cap-alerts' | 'isolines' | 'gl-particles' | 'particles'>;
 export interface RendererInitParams {
     ident: Renderers;

package/types/client/Webcams.d.ts

@@ -1,8 +1,8 @@
 import { ClickHandler } from '@windy/ClickHandler';
-import type { ClickHandlerInitParams } from '@windy/ClickHandler';
-import type { WebcamDetail, WebcamsLoadingParams, WebcamMetadata } from '@windy/Webcams.d';
-import type { Plugins } from '@windy/plugins.d';
-import type { LatLon } from '@windy/interfaces';
+import type { ClickHandlerInitParams } from './d.ts.files/ClickHandler';
+import type { WebcamDetail, WebcamsLoadingParams, WebcamMetadata } from './d.ts.files/Webcams.d';
+import type { Plugins } from './d.ts.files/plugins.d';
+import type { LatLon } from './d.ts.files/interfaces';
 export type WebcamsInitParams = {
     useHover?: boolean;
     maxAmount?: number;

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

@@ -0,0 +1,87 @@
+import { LoadedTranslations } from '@windy/trans.d';
+import { Timestamp, ISODateString } from '@windy/types.d';
+
+/**
+ * Main minifest object. Mother of all forecasts
+ */
+export interface MinifestObject {
+    /**
+     * Version
+     */
+    v: string;
+
+    /**
+     * Array of hour moments that contain forecast data
+     */
+    dst: number[][];
+
+    /**
+     * Main identifier, identifiing the refTime on the backend.
+     */
+    info: string;
+
+    /**
+     * Reference time of forecast
+     */
+    ref: ISODateString;
+
+    /**
+     * Update time of the forecast
+     */
+    update: ISODateString;
+
+    /**
+     * In an emergency case backend can set `force` property at minifest. It breaks minifest client cache and set minifest at any circumstances
+     */
+    forced?: boolean;
+}
+
+/**
+ * Main Calendar Day Object
+ */
+export interface CalendarDay {
+    /**
+     * Translation ID for week day abbreviation
+     */
+    display: keyof LoadedTranslations;
+
+    /**
+     * Translation ID for week day abbreviation
+     */
+    displayLong: keyof LoadedTranslations;
+
+    /**
+     * Start of the day
+     */
+    start: Timestamp;
+
+    /**
+     * End of the day
+     */
+    end: Timestamp;
+
+    /**
+     * Midday of the day
+     */
+    middayTs: Timestamp;
+
+    /**
+     * Day of the month
+     */
+    day: number;
+
+    /**
+     * month
+     */
+    month: number;
+
+    /**
+     * year
+     */
+    year: number;
+}
+
+/**
+ * Valid translation keys
+ */
+export type Weekday = 'SUN' | 'MON' | 'TUE' | 'WED' | 'THU' | 'FRI' | 'SAT';

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

@@ -0,0 +1,70 @@
+export class CanvasLayer extends L.Layer {
+    targetPane?:
+        | 'mapPane'
+        | 'tilePane'
+        | 'overlayPane'
+        | 'objectsPane'
+        | 'popupPane'
+        | 'shadowPane'
+        | 'markerPane';
+    _showCanvasOn?: boolean;
+    failed?: boolean;
+    _canvas?: L.CanvasElement | null;
+    _center?: L.LatLng;
+    _zoom?: number;
+    _frame?: number | null;
+    wasOnZoom?: boolean;
+    options: L.LayerOptions & {
+        disableAutoReset: boolean;
+        padding: number;
+    };
+
+    initialize(this: this, options?: L.LayerOptions): void;
+    onResizeCanvas(this: this, width: number, height: number): void;
+    showCanvas(this: this, on: boolean): void;
+    reset(this: this): void;
+    canvasDisplay(this: this, enable: boolean): void;
+    getCanvas(this: this): L.CanvasElement | undefined | null;
+    redraw(this: this): void;
+
+    _resize(this: this, event: L.ResizeEvent): void;
+    _animateZoom(this: this, e: L.ZoomAnimEvent): void;
+    _onZoom(this: this): void;
+    _onZoomStart(this: this): void;
+    _onZoomEnd(this: this): void;
+    _moveEnd(this: this): void;
+    _reset(this: this): void;
+    _redraw(this: this): void;
+    _updateTransform(center: L.LatLng, zoom: number): void;
+
+    /** TODO empty by default */
+    onInit(this: this): void;
+
+    /** TODO true by default */
+    onCreateCanvas(this: this, canvas?: HTMLElement): boolean;
+
+    /** TODO empty by default */
+    onCanvasFailed(this: this): void;
+
+    /** TODO empty by default */
+    onRemoveCanvas(this: this, canvas?: HTMLElement): void;
+
+    /** TODO empty by default */
+    onMoveEnd(this: this): void;
+
+    /** TODO empty by default */
+    onZoomEnd(this: this): void;
+
+    /** TODO empty by default */
+    onReset(this: this): void;
+
+    // Just this typings rewrites of leaflet methods
+    onAdd(this: this, map: L.Map): this;
+    addTo(this: this, map: L.Map): this;
+    onRemove(this: this, map: L.Map): this;
+
+    onContextLost(): void;
+    onContextRestored(): void;
+    onContextCreationError(e: WebGLContextEvent): void;
+    canvasHooks(canvas: L.CanvasElement | null | undefined, on: boolean): void;
+}

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

@@ -0,0 +1,82 @@
+import { NumValue } from '@windy/types.d';
+
+export type RGBA = [number, number, number, number];
+
+export type YUVA = [number, number, number, number];
+
+export type ColorGradient = [NumValue, RGBA][];
+
+/**
+ * 'rgb(200,0,150)'
+ */
+export type RGBString = string;
+
+/**
+ * 'rgba(200,0,150,1)'
+ */
+export type RGBAString = string;
+
+export type ColorIdent =
+    | 'temp'
+    | 'wind'
+    | 'rh'
+    | 'pressure'
+    | 'cclAltitude'
+    | 'altitude'
+    | 'deg0'
+    | 'levels'
+    | 'rain'
+    | 'ptype'
+    | 'rainClouds'
+    | 'clouds'
+    | 'lclouds'
+    | 'hclouds'
+    | 'mclouds'
+    | 'cape'
+    | 'lightDensity'
+    | 'cbase'
+    | 'snow'
+    | 'rainAccu'
+    | 'waves'
+    | 'currents'
+    | 'currentsTide'
+    | 'visibility'
+    | 'gtco3'
+    | 'aod550'
+    | 'pm2p5'
+    | 'no2'
+    | 'tcso2'
+    | 'go3'
+    | 'cosc'
+    | 'dust'
+    | 'satellite'
+    | 'radar'
+    | 'fog'
+    | 'justGray'
+    | 'efiWind'
+    | 'efiTemp'
+    | 'efiRain'
+    | 'moistureAnom40'
+    | 'moistureAnom100'
+    | 'drought40'
+    | 'drought100'
+    | 'soilMoisture40'
+    | 'soilMoisture100'
+    | 'fwi'
+    | 'dfm10h'
+    | 'solarpower'
+    | 'uvindex'
+    | 'turbulence'
+    | 'icing'
+    | 'wetbulbtemp';
+
+type PluginColorIdent =
+    | 'airQ'
+    | 'windDetail'
+    | 'wavesDetail'
+    | 'periodDetail'
+    | 'altitudeDetail'
+    | 'visibilityDetail'
+    | 'dewpointSpreadDetail'
+    | 'blitz'
+    | 'radiation';

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

@@ -0,0 +1,45 @@
+import { MapCoordinates } from '@windy/dataSpecifications.d';
+
+export interface TilePoint {
+    x: number;
+    y: number;
+    z: number;
+}
+
+export interface ExtendedTileParams extends MapCoordinates {
+    /**
+     * => bounds.min.x of map.getPixelBounds();
+     */
+    pixelOriginX: number;
+
+    /**
+     * => bounds.min.y of map.getPixelBounds();
+     */
+    pixelOriginY: number;
+
+    /**
+     * Data zoom
+     */
+    dZoom: number;
+
+    /**
+     * Size of map in piels
+     */
+    width: number;
+
+    /**
+     * Size of map in pxels
+     */
+    height: number;
+
+    /**
+     * Coords of original unwrapped map tiles
+     * basicaly map.getPixelBounds();
+     */
+    origTiles: {
+        minX: number;
+        minY: number;
+        maxX: number;
+        maxY: number;
+    };
+}

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

@@ -0,0 +1,92 @@
+import type { Texture2D } from 'plugins/_shared/gl-lib/gl-lib';
+import type {
+    Mat2,
+    Mat2d,
+    Mat3,
+    Mat4,
+    Quat,
+    Quat2,
+    Vec2,
+    Vec3,
+    Vec4,
+} from '@plugins/globe/gl-matrix/types';
+
+export interface CustomError extends Error {
+    contextLost?: boolean;
+    isVertexShader?: boolean;
+    name: string;
+    full?: string;
+}
+
+// export type WebGLProgramObject = {
+//     [whatever: string]: any;
+// };
+
+export type UniformName = `u${string}`;
+
+export type AttributeName = `a${string}`;
+
+export type SamplerName = `s${string}`;
+
+export type WebGLProgramAttributes = {
+    [attribute: AttributeName]: number;
+};
+
+export type WebGLProgramUniforms = {
+    [uniform: UniformName]: WebGLUniformLocation | null;
+    [sampler: SamplerName]: WebGLUniformLocation | null;
+};
+
+export type WebGLProgramParams = WebGLProgramAttributes & WebGLProgramUniforms;
+
+export type AnyUniform = number | Vec2 | Vec3 | Vec4 | Mat2 | Mat2d | Mat3 | Mat4 | Quat | Quat2;
+
+export type ShaderPars = {
+    uVPars0?: Vec4;
+    uVPars1?: Vec4;
+    uVPars2?: Vec4;
+
+    uMatRot?: Mat3;
+
+    uPars0?: Vec4;
+    uPars1?: Vec4;
+} & {
+    [uniform: UniformName]: AnyUniform;
+    [uniform: SamplerName]: Texture2D | WebGLTexture | null;
+};
+
+export type WebGLProgramObject = {
+    program: WebGLProgram | null;
+    aPos?: number;
+    variantI?: number; // property added in VisualizerShader.compile()
+} & WebGLProgramParams;
+
+export interface ExtendedWebGLTexture extends WebGLTexture {
+    _width?: GLsizei;
+    _height?: GLsizei;
+    _format?: GLenum;
+}
+
+/**
+ * Canvas as HTML element with added properties
+ */
+//  export interface Canvas extends HTMLCanvasElement {
+//     cssWidth: number;
+//     cssHeight: number;
+//     cssHeightInner: number;
+//     pxRatio: number;
+//     heightInner: number;
+// }
+
+export type HTMLCanvasExtended = HTMLCanvasElement & {
+    cssWidth: number;
+    cssHeight: number;
+    cssHeightInner: number;
+    pxRatio: number;
+    heightInner: number;
+};
+
+/**
+ * HTML canvas element or HTML canvas element with added properties
+ */
+export type Canvas = HTMLCanvasElement | HTMLCanvasExtended;

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

@@ -0,0 +1,51 @@
+import { Timestamp } from '@windy/types.d';
+
+type CityDivId = string; // `${x}:${y}`
+type CityLabelId = string; // `${lat}/${lon}`
+
+/** Loaded forecast data from `/citytile/*` URL endpoint */
+export type CityForecastData = {
+    /**
+     * Forecasted temperatures for cities on the tile
+     */
+    forecast: {
+        /**
+         * Keys (coordinates) are in "lat/lon" format, value the forecasted temperature
+         */
+        [coordinates: string]: number[];
+    };
+    /** Reftime */
+    reftime: Timestamp;
+    /** Time from reftime in hours for every temperature value in the returned array */
+    hours: number[];
+};
+
+/**
+ * Loaded labels data from tiles.windy.com endpoint
+ * Format of inner arrays is [id, title to show, category of label used for CSS class, lon, lat, width in px, height in px]
+ */
+export type CityLabelData = [string, string, string, number, number, number, number][];
+
+/** Represantation of single one HTML label with its temperature data */
+export interface CityLabel {
+    /** Id of the label, it is same as a key for CityForecastData, so it is used for pairing label with temperature data */
+    id: CityLabelId;
+
+    /** HTML element of the label for binding labels and temperature values */
+    el: HTMLDivElement;
+
+    /** Forecast data with temperature in K, it is lazy loaded with forecast request */
+    data?: number[];
+}
+
+/** Representation of one leaflet tile with its CityLabels */
+export interface CityDiv {
+    /** Labels included in the leaflet tile */
+    labels: CityLabel[];
+
+    /** Mercator URL frag in format <z>/<x>/<y>. It is lazy binded when tile is created */
+    urlFrag?: string;
+
+    /* Array of timestamps for which the temperatures are forecasted. Lazy loaded with forecast request */
+    timestamps?: Timestamp[];
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Leaflet layer with alpha-inverse sea mask
+ */
+export class LandMask extends L.TileLayer {
+    seaColorL: number;
+    ctx: CanvasRenderingContext2D | null;
+    _tileOnError(
+        done: L.DoneCallback,
+        tile: HTMLImageElement | HTMLCanvasElement,
+        e: string | Event,
+    ): void;
+    getTempCtx(): CanvasRenderingContext2D | null;
+    getTileUrl(coords: L.Coords): string;
+    createTile(coords: L.Coords, done: L.DoneCallback): HTMLCanvasElement | HTMLImageElement;
+    createImageTile(coords: L.Coords, done: L.DoneCallback): HTMLImageElement;
+    createCanvasTile(coords: L.Coords, done: L.DoneCallback): HTMLCanvasElement;
+}