@windycom/plugin-devtools 3.0.2 → 3.0.3

package/types/interfaces.d.ts

@@ -2,10 +2,8 @@
  * Main Windy interfaces
  */
 import { Weekday } from '@windy/Calendar';
-import { ExtendedTileParams } from '@windy/DataTiler.d';
 import { FavId } from '@windy/favs';
 import { Layers } from '@windy/Layer';
-import { Particles } from '@windy/Particles';
 import { PluginOpenEventSource, PluginsOpenParams, PluginsQsParams } from '@windy/plugin-params.d';
 import { Plugins } from '@windy/plugins.d';
 import { DataQuality } from '@windy/Product';
@@ -23,6 +21,7 @@ import {
     GpsPreferences,
     Hours,
     ISODateString,
+    ISOCountryCode,
     LocationPreferences,
     MeteogramLayers,
     MeteogramLevels,
@@ -42,8 +41,9 @@ import {
     WidgetNotificationPreferences,
     WidgetType,
     YearMonthDay,
+    type SemVersion,
 } from '@windy/types.d';
-import type { PaddingOptions, RequireAtLeastOne } from '@windycom/maplibre-gl';
+import type { LatLng, Marker, PaddingOptions, RequireAtLeastOne } from '@leafletGl';
 
 export interface ExportedObj {
     default?: unknown;
@@ -107,7 +107,7 @@ export interface GeolocationInfo extends LatLon {
     /**
      * Optional lowercase 2 letter ISO country code
      */
-    cc?: string;
+    cc?: ISOCountryCode;
 
     /**
      * Optional name of the place
@@ -280,9 +280,9 @@ export interface LastSentDevice {
     deviceID: string;
     platform: string;
     target: string;
-    version: string;
+    version: SemVersion;
     subscription: SubTier;
-    cc: string;
+    cc: ISOCountryCode | 'xx';
     deactivated?: boolean;
     updated?: number;
     screen?: {
@@ -311,9 +311,9 @@ export interface TilePoint {
 }
 
 /**
- * Celestial object as received from backend
+ * Timezone information as received from backend
  */
-export interface Celestial {
+export interface TZinfo {
     /**
      * Time zone abbreviation (for instance CEST)
      */
@@ -343,7 +343,12 @@ export interface Celestial {
      * Type of TZ type t..terrestrial, n..nautical
      */
     TZtype: 't' | 'n';
+}
 
+/**
+ * Celestial object as received from backend
+ */
+export interface Celestial extends TZinfo {
     /**
      * Determines probability if the location is at sea or not as number from 1..0
      * Unfortunately the number is inverted, so 1 means land, and 0 means sea
@@ -377,6 +382,11 @@ export interface Celestial {
     sunsetTs: Timestamp;
 }
 
+export type CelestialWithoutTimezone = Pick<
+    Celestial,
+    'night' | 'sunsetTs' | 'sunriseTs' | 'duskTs' | 'isDay' | 'atSea'
+>;
+
 /**
  * Summary day as received from backend
  */
@@ -992,25 +1002,6 @@ export interface MeteogramDataPayload {
     data: MeteogramDataHash;
 }
 
-/**
- * Particle animation parameters
- */
-export interface ExtendedRenderParams extends ExtendedTileParams, FullRenderParameters {
-    canvas: HTMLCanvasElement;
-
-    /**
-     * Actual instance of particles
-     */
-    partObj: Particles;
-
-    /**
-     * Pointer to dest table
-     */
-    vectors: Float32Array;
-
-    speed2pixel: number;
-}
-
 /**
  * How good are observations by this AD or WX station?
  */
@@ -1022,7 +1013,7 @@ export interface ObservationInfo {
 }
 
 export interface ServiceGeoipResponse {
-    country: string;
+    country: ISOCountryCode;
     region: `${number}`;
     eu: '0' | '1';
     timezone: string;
@@ -1031,11 +1022,6 @@ export interface ServiceGeoipResponse {
     metro: number;
     area: number;
     ip: string;
-
-    /**
-     * @deprecated
-     */
-    hash: 'oiurouoweruouoiuou';
 }
 
 export interface BillingPluginMinimalProduct {
@@ -1216,19 +1202,38 @@ export interface WindyWatchPlugin {
     addWatchFace: () => Promise<unknown>;
 }
 
-export interface WindyServicePlugin {
+export interface WindyServicesPlugin {
     openSettings: () => Promise<void | string>;
     getLocationPermissions: () => Promise<LocationPreferences>;
     getNotificationPermissions: () => Promise<NotificationPreferences>;
     openApplicationSettings: () => Promise<void | string>;
     isGpsEnabled: () => Promise<GpsPreferences>;
-    getBatteryUsagePermissions: () => Promise<BatteryPreferences>;
+    /**
+     * Android-only function that checks whether the app has battery usage permissions.
+     *
+     * - If the user has no widget installed, it always resolves to "authorized".
+     * - Otherwise, it may resolve to:
+     * - "authorized" → permission granted
+     * - "denied" → permission restricted
+     *
+     * May be undefined on non-Android platforms.
+     *
+     * @returns {Promise<BatteryPreferences>} A promise resolving to "authorized" or "denied".
+     * */
+    getBatteryUsagePermissions?: () => Promise<BatteryPreferences>;
     openBatterySettings: () => Promise<void>;
     getGoogleServicesAvailability: () => Promise<GoogleServicesPreferences>;
     getWidgetNotificationPermissions: () => Promise<WidgetNotificationPreferences>;
     openWidgetNotificationSettings: () => Promise<void>;
-    getBackgroundLocationPermission: () => Promise<BatteryPreferences>;
-    getBatteryStatus: () => Promise<BatteryPreferences>;
+    getBackgroundLocationPermission: () => Promise<GpsPreferences>;
+    /**
+     * Android-only function that checks whether the app has battery usage permissions.
+     *
+     * May be undefined on non-Android platforms.
+     *
+     * @returns {Promise<BatteryPreferences>} A promise resolving to "authorized" or "denied".
+     */
+    getBatteryStatus?: () => Promise<BatteryPreferences>;
     openBackgroundLocationSettings: () => Promise<void>;
     logError: (arg: { moduleName: string; msg: string; error?: string }) => Promise<void>;
     getId: () => Promise<{ identifier: string }>;
@@ -1329,6 +1334,74 @@ export interface WindyMigrationPlugin {
     getOldLocalStorageDataAndroid: () => Promise<{ result: string | null }>;
 }
 
+export interface ImageOptions {
+    maxWidth?: number;
+    maxHeight?: number;
+    quality?: number; // 0..1
+    format?: 'jpeg' | 'png'; // default 'jpeg'
+}
+
+export interface VideoOptions {
+    preset?: 'medium' | 'low' | 'h264_720p' | 'h264_1080p' | 'passthrough'; // Medium is default
+}
+
+export interface CompressOptions {
+    imageOptions?: ImageOptions;
+    videoOptions?: VideoOptions;
+}
+
+export interface OneCompressOptions extends CompressOptions {
+    id: string;
+}
+
+export interface PickedItem {
+    id: string;
+    kind: 'image' | 'video' | 'unknown';
+    filename?: string;
+    mimeType?: string;
+    originalPath?: string; // POSIX path to original temp file
+    width?: number;
+    height?: number;
+    duration?: number;
+    size?: number; // bytes
+}
+
+export interface CompressedItem extends PickedItem {
+    compressedPath: string; // POSIX path to compressed file
+    compressedSize: number; // bytes
+}
+
+/**
+ * Extended MediaItem type that supports both native compressed items
+ * and web-based items with blob references
+ */
+export interface MediaItem extends PickedItem {
+    compressedPath?: string; // For native plugin
+    compressedSize?: number;
+    blob?: Blob; // For web fallback (full-size, no compression)
+    blobUrl?: string; // Object URL for preview
+}
+
+type PickOptions = {
+    selectionLimit?: number;
+};
+
+// iOS only
+export interface WindyMediaPlugin {
+    pick(options?: PickOptions): Promise<{ items: PickedItem[] }>;
+    getPicked(): Promise<{ items: PickedItem[] }>;
+    removeFromPicked(id: string): Promise<{ success: boolean }>;
+    pickAndCompress(options?: PickOptions): Promise<{ items: CompressedItem[] }>;
+    compressOne(arg: OneCompressOptions): Promise<{ item: CompressedItem }>;
+    // CompressAll - if compress options are not provided, default options will be used
+    compressAll(arg: CompressOptions | undefined): Promise<{ items: CompressedItem[] }>;
+    clearAll(): Promise<void>;
+    addListener(
+        eventName: 'compressionProgress',
+        listener: (payload: { total: number; done: number; percent: number }) => void,
+    ): { remove: () => void };
+}
+
 export interface SocialLoginParams {
     purpose: string;
     deviceId: string;
@@ -1402,8 +1475,8 @@ export interface PluginOpeningOptions<P extends keyof Plugins> extends WindowOpe
  */
 export interface RplannerPoint {
     ident: number;
-    marker: L.Marker;
-    position: L.LatLng;
+    marker: Marker;
+    position: LatLng;
 }
 
 /**
@@ -1413,7 +1486,7 @@ export interface RplannerWaypoint {
     distance?: number;
     ident?: number;
     initialBearing?: number;
-    point: L.LatLng;
+    point: LatLng;
     rads?: {
         cosInitialBearing: number;
         cosLat: number;
@@ -1524,7 +1597,7 @@ export interface ExternalPluginConfig {
      *
      * @example '1.0.0'
      */
-    version: string;
+    version: SemVersion;
 
     /**
      * Official title of the plugin, that will be displayed as a browser title,
@@ -1644,6 +1717,11 @@ export interface CompiledExternalPluginConfig extends ExternalPluginConfig {
  * Already installed external plugin
  */
 export interface InstalledExternalPluginConfig extends CompiledExternalPluginConfig {
+    /**
+     * ID must be present to enable backend cloud sync
+     */
+    id: string;
+
     /**
      * URL of the plugin is used as unique identifier
      */
@@ -1652,7 +1730,7 @@ export interface InstalledExternalPluginConfig extends CompiledExternalPluginCon
     /**
      * From which process was plugin installed
      */
-    installedBy: 'dev' | 'gallery' | 'url' | 'patch';
+    installedBy: 'dev' | 'gallery' | 'url';
 
     /**
      * When was this plugin installed by specific user
@@ -1666,64 +1744,6 @@ interface PromoFilteringParams {
     isPremium: boolean;
 }
 
-/**
- * Main promo object, used in `client-patch`
- */
-interface PromoObj {
-    /**
-     * Main ID of the promo. This key is also used in `promo` object in localStorage
-     */
-    readonly id: string;
-
-    /**
-     * ISO date, when the promo expires
-     */
-    readonly end: string;
-
-    /**
-     * How many times display promo to the user (respective on one device)
-     */
-    counter: number;
-
-    /**
-     * How often to display promo on particular device (in ms)
-     */
-    delay: number;
-
-    /**
-     * Any others filters, deciding whether to display promo or not
-     */
-    filter: () => boolean;
-
-    /**
-     * Should we display HP articles together with promo
-     * @deprecated
-     */
-    loadArticles?: boolean;
-
-    /**
-     * Required method to be run, when promo is executed. In this stage we can also
-     * do some additional checks, if promo should be displayed or not, so we must
-     * call `promo.hitCounter()` method ourselves.
-     */
-    readonly run: () => void;
-
-    /**
-     * Optional HTML code to be used internally in `run` method
-     */
-    html?: string;
-}
-
-/**
- * Client patch object
- */
-interface ClientPatch {
-    __version: string;
-    __css: string;
-    exclusivePromos: PromoObj[];
-    otherPromos: PromoObj[];
-}
-
 /**
  * Amount of active hurricanes as returnd from hurricane tracker backend
  */
@@ -1817,6 +1837,7 @@ interface FullRenderParameters extends WeatherParameters, RenderParams {
      */
     acRangeInHours?: number;
 
+    // TODO: Why this does not use FileSuffix type?
     fileSuffix?: 'png' | 'jpg' | 'json';
 }