@windycom/plugin-devtools 1.0.7 → 1.0.9

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@windycom/plugin-devtools",
-    "version": "1.0.7",
+    "version": "1.0.9",
     "description": "Developer tools and TS declarations for developers of Windy Plugins.",
     "main": "index.mjs",
     "module": "index.mjs",
@@ -12,7 +12,6 @@
         "@rollup/plugin-terser": "^0.4.4",
         "@rollup/plugin-typescript": "^11.1.6",
         "@types/geojson": "^7946.0.14",
-        "@windycom/plugin-devtools": "file:../windy-plugins-devtools/dist",
         "eslint-import-resolver-typescript": "^3.6.1",
         "eslint-plugin-svelte": "^2.35.1",
         "less": "^4.2.0",

package/types/client/Overlay.d.ts

@@ -4,7 +4,7 @@ import type { Metric } from '@windy/Metric';
 import type { DirectionFunction } from '@windy/format.d';
 import type { Iconfont } from '@windy/iconfont.d';
 import type { Overlays } from '@windy/rootScope.d';
-import type { RGBNumValues } from '@windy/tileInterpolator.d';
+import type { RGBNumValues } from '@windy/interpolatorTypes';
 import type { LoadedTranslations } from '@windy/trans.d';
 import type { HTMLString } from '@windy/types';
 export type UsedOverlays = Overlays | 'gh' | 'swell' | 'satelliteIRBT';

package/types/client/OverlayClasses.d.ts

@@ -1,7 +1,7 @@
 import { Overlay } from '@windy/Overlay';
 import type { DirectionFunction } from '@windy/format.d';
 import type { Overlays } from '@windy/rootScope.d';
-import type { RGBNumValues } from '@windy/tileInterpolator.d';
+import type { RGBNumValues } from '@windy/interpolatorTypes';
 import type { LoadedTranslations } from '@windy/trans.d';
 export declare class CurrentOverlay<I extends Overlays | 'gh' = Overlays | 'gh'> extends Overlay<I> {
     createPickerHTML(values: RGBNumValues, formatDir: DirectionFunction): string;

package/types/client/Plugin.d.ts

@@ -55,8 +55,8 @@ export declare class Plugin<P extends PluginIdent> {
      * and should prevent opening several overlapping plugins at the same location
      * especially on desktop or tablet devices.
      *
-     * On mobile phones, most of the plugins (expecially LH, RH pane) become
-     * fullsctreen plugins.
+     * On mobile phones, most of the plugins (especially LH, RH pane) become
+     * fullscreen plugins.
      */
     pane?: PluginPane;
     /**
@@ -83,8 +83,8 @@ export declare class Plugin<P extends PluginIdent> {
     plugin?: WPluginModules[`@plugins/${P}`] & AdditionalPluginAssets;
     /**
      * Whenever set, this plugin (when opened) disables opening
-     * of mobile picker on map interaction. Shoul be used with
-     * bottm, top pane plugins and plugins, that can be opened
+     * of mobile picker on map interaction. Should be used with
+     * bottom, top pane plugins and plugins, that can be opened
      * in half
      */
     disableMobilePicker?: boolean;

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

@@ -15,8 +15,8 @@ import {
     Consent,
     GeolocationInfo,
     HomeLocation,
-    LatLon,
     InstalledExternalPluginConfig,
+    LatLon,
 } from '@windy/interfaces.d';
 
 import {
@@ -33,10 +33,10 @@ import { ColorGradient } from '@windy/Color.d';
 
 import { MetricItem } from '@windy/Metric.d';
 
+import type { SubscriptionInfo } from '@plugins/_shared/subscription-services/subscription-services.d';
 import type { DownloadedInfo, OfflineConfiguration } from '@plugins/offline/offline.d';
-import type RadarCalendar from '@plugins/_radar/calendar/RadarCalendar';
+import type RadarCalendar from '@plugins/radar/calendar/RadarCalendar';
 import type SatelliteCalendar from '@plugins/satellite/calendar/SatelliteCalendar';
-import type { SubscriptionInfo } from '@plugins/_shared/subscription-services/subscription-services.d';
 
 /**
  * Custom animation particles settings
@@ -912,6 +912,11 @@ export interface DataSpecifications {
      */
     twitterConsent: DataSpecificationsObject<Omit<Consent, 'analytics'> | null>;
 
+    /**
+     * Counter to synchronize Client and native backup data
+     */
+    appLocalStorageCounter: DataSpecificationsObject<number | null>;
+
     /**
      * List of installed external plugins
      * @ignore

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

@@ -221,6 +221,7 @@ export type PluginsOpenParams = {
     offline: PluginSource;
     'developer-mode': (PluginSource & { qs: Record<string, string> | undefined }) | undefined;
     'windy-external-plugin': PluginSource & LatLon;
+    menu: PluginSource;
 } & {
     [external: ExternalPluginIdent]:
         | (PluginSource & { query: Record<string, string> | undefined })

package/types/client/embed2.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@windy/declarations/windy-modules" />
 import './utils/errorLogger';
 import './leafletExt/CanvasLayer';
 import './services/params';

package/types/client/interpolator.d.ts

@@ -1,5 +1,4 @@
-import type { CoordsInterpolationFun, PixelInterpolationFun, RGBNumValues, InterpolatorPossibleReturns } from '@windy/tileInterpolator.d';
-export type { CoordsInterpolationFun, PixelInterpolationFun, RGBNumValues, InterpolatorPossibleReturns, };
+import type { CoordsInterpolationFun, PixelInterpolationFun } from '@windy/interpolatorTypes';
 export type InterpolatorFactory = {
     createFun: (cb: <T>(...args: unknown[]) => T | void) => void;
 };

package/types/client/nativeStorage.d.ts

@@ -14,4 +14,18 @@ export interface WindyWidgetPlugin {
         value: boolean;
     }>;
 }
+export interface WindyBackupPlugin {
+    syncCounter: (arg: {
+        clientCounter: number;
+    }) => Promise<{
+        nativeCounter: number;
+        backup?: string;
+    }>;
+    saveBackup: (arg: {
+        clientCounter: number;
+        backup: string;
+    }) => Promise<void>;
+    reloadApp: () => Promise<void>;
+    clearBackup: () => Promise<void>;
+}
 export {};

package/types/client/pluginsCtrl.d.ts

@@ -1,7 +1,16 @@
 /**
- * @module pluginsCtrl
+ * # @windy/pluginCtrl
+ *
+ * Handles opening and closing of plugins, solving UI collisions by closing plugins
+ * that can overlap other plugins.
+ *
+ * Can be used from other modules
+ * just by emitting `rqstOpen`, `rqstClose` or `closeAllPlugins` events,
+ * on {@link module:bcast} channel in order to avoid circular dependencies.
  *
- * Handles opening and closing of plugins. Can be used from other modules
- * just by emitting `rqstOpen`, `rqstClose` or `closeAllPlugins` events.
+ * Unless we are opening external plugins, `openPlugin` provides satisfactory
+ * type safety of provided plugin parameters.
+ *
+ * @module pluginsCtrl
  */
 export {};

package/types/client/renderTile.d.ts

@@ -3,4 +3,4 @@ import type { TileParams } from '@windy/Renderer.d';
 import type { TileLayerCanvas } from '@windy/TileLayerCanvas.d';
 declare const renderNoDataTile: (canvas: HTMLCanvasElement, url?: string) => void;
 declare const renderTile: (this: TileLayerCanvas, step: 1 | 2, canvas: HTMLCanvasElement, rqrdSyncNum: number, tInfo: TileParams, dTile: DataTile) => void;
-export { renderTile, renderNoDataTile };
+export { renderNoDataTile, renderTile };

package/types/client/renderers.d.ts

@@ -8,7 +8,7 @@ declare const renderers: {
      */
     tileLayer: TileLayer;
     noUserControl: TileLayer;
-    radar: Renderer<"radar", typeof import("../../plugins/_radar/radar")>;
+    radar: Renderer<"radar", typeof import("../../plugins/radar/radar")>;
     satellite: Renderer<"satellite", typeof import("../../plugins/satellite/satellite")>;
     capAlerts: Renderer<"cap-alerts", typeof import("../../plugins/cap-alerts/cap-alerts")>;
     isolines: Renderer<"isolines", typeof import("../../plugins/isolines/isolines")>;

package/types/client/rootScope.d.ts

@@ -79,7 +79,7 @@ export declare const overlays: readonly ["radar", "satellite", "wind", "gust", "
 /**
  * List of valid accumulation times
  */
-export declare const acTimes: readonly ["next12h", "next24h", "next2d", "next48h", "next60h", "next3d", "next5d", "next10d"];
+export declare const acTimes: readonly ["next12h", "next24h", "next36h", "next2d", "next48h", "next60h", "next3d", "next5d", "next10d"];
 /**
  * Identifier of products that cover only certain area
  */
@@ -140,6 +140,10 @@ export declare const prefLang: string;
 export declare const levelsData: {
     [L in (typeof levels)[number]]: [string, string];
 };
+/**
+ * Maximum number of fav POIs displayed in the GUI
+ */
+export declare const maxFavPoisDesktop = 7;
 /**
  * Valid POI layers, their name and icon
  * @ignore this will crash Markdown parser

package/types/client/tileInterpolator.d.ts

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

@@ -4,7 +4,7 @@ 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/tileInterpolator.d';
+import type { RGBNumValues } from '@windy/interpolatorTypes';
 import type { HTMLString, Timestamp, ExtendedStationType } from '@windy/types.d';
 /**
  * One minute in ms.
@@ -273,7 +273,7 @@ export declare const getAdjustedNow: (syncTime?: number) => number;
  */
 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
+ * Safely joins server name and path
  *
  * @param url1 URL to join
  * @param url2 URL to join

package/types/interfaces.d.ts

@@ -1748,6 +1748,16 @@ export interface CompiledExternalPluginConfig extends ExternalPluginConfig {
      * If the final build contains screenshot, they are stored here
      */
     screenshot?: string;
+
+    /**
+     * User ID of the author of the plugin
+     */
+    windyUserId: number;
+
+    /**
+     * URL of users profile
+     */
+    communityProfileUrl: string;
 }
 
 /**

package/types/types.d.ts

@@ -1,5 +1,7 @@
 import weatherTable from '@plugins/_shared/detail-render/weatherTable';
-import { WeatherParameters, LatLon } from './interfaces';
+import { WeatherParameters, LatLon } from './interfaces.d';
+
+export * from '@windy/interpolatorTypes.d';
 
 /**
  * ISO date string representation of the Date

package/publishExamples.sh

@@ -1,19 +0,0 @@
-#!/bin/bash
-
-source .secret-api-key.sh
-
-NAME=example
-SHA=$(git rev-parse --short HEAD)
-OWNER=windycom
-
-DIR=dist/example06
-
-cd ./$DIR
-echo "Creating plugin archive..."
-echo "{\"repositoryName\": \"https://github.com/windycom/windy-plugin-template\", \"commitSha\": \"${SHA}\", \"repositoryOwner\": \"${OWNER}\"}" > ./plugin-info.json
-jq -s '.[0] * .[1]' ./plugin.json ./plugin-info.json > ./plugin2.json
-rm ./plugin.json && mv ./plugin2.json ./plugin.json
-tar cf ./plugin.tar --exclude='./plugin.tar' .
-echo "Publishing plugin..."
-curl -s --fail-with-body -XPOST 'https://api.windy.com/api/windy-plugins/v1.0/upload' -H "x-windy-api-key: ${WINDY_API_KEY}" -F "plugin_archive=@./plugin.tar"
-rm ./plugin.tar