@windycom/plugin-devtools 1.0.4 → 1.0.5

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

@@ -0,0 +1,160 @@
+import { LatLon } from '@windy/interfaces.d';
+import { Timestamp } from '@windy/types.d';
+import { HttpPayload } from '@windy/http.d';
+
+export type WebcamCategoryType =
+    | 'landscape'
+    | 'traffic'
+    | 'meteo'
+    | 'uncategorized'
+    | 'building'
+    | 'indoor'
+    | 'city'
+    | 'water'
+    | 'area'
+    | 'forest'
+    | 'mountain'
+    | 'island'
+    | 'beach'
+    | 'airport'
+    | 'park'
+    | 'harbor'
+    | 'pool'
+    | 'golf'
+    | 'lake'
+    | 'bay'
+    | 'square'
+    | 'coast'
+    | 'sportarea'
+    | 'resort'
+    | 'camping'
+    | 'other'
+    | 'xmasmarket'
+    | 'underwater';
+
+export type WebcamPositionType = 'fix' | 'rotating' | 'ptz';
+
+export type WebcamDirectionType =
+    | ''
+    | 'north'
+    | 'northeast'
+    | 'east'
+    | 'southeast'
+    | 'south'
+    | 'southwest'
+    | 'west'
+    | 'northwest';
+
+export type WebcamStatusType =
+    | 'active'
+    | 'deleted'
+    | 'disabled'
+    | 'duplicate'
+    | 'inactive'
+    | 'rejected'
+    | 'revoked'
+    | 'unapproved';
+
+export interface WebcamCategory {
+    id: WebcamCategoryType;
+    name: string;
+}
+
+export interface WebcamLocation extends LatLon {
+    alt: number;
+    city: string;
+    continent: string;
+    country: string;
+    subcountry: string;
+    title: string;
+}
+
+export interface WebcamImageUrls {
+    full: string;
+    icon: string;
+    normal: string;
+    original: string;
+    preview: string;
+    teaserbg: string;
+    thumbnail: string;
+    webcam: string;
+}
+
+export type WebcamImageSize = keyof WebcamImageUrls;
+
+export type WebcamTimelapseType = 'day' | 'current' | 'all';
+export interface WebcamDetail {
+    categories: WebcamCategoryType[];
+    contacts: { owner: string; caretaker: string };
+    id: number;
+    images: {
+        current: WebcamImageUrls;
+        daylight: WebcamImageUrls;
+        sizes: { [S in keyof WebcamImageUrls]: { width: number; height: number } };
+    };
+    lastDaylight: Timestamp;
+    lastUpdate: Timestamp;
+    location: WebcamLocation;
+    pageUrl: string;
+    shortTitle: string;
+    timelapseType: WebcamTimelapseType;
+    title: string;
+    views: Record<string, string>;
+    viewCount: number;
+    stream?: string;
+    l10n?: {
+        /** {[langIsoCode: string]: string} */
+        country: Record<string, string>;
+        /** {[langIsoCode: string]: string} */
+        subcountry: Record<string, string>;
+        /** {[langIsoCode: string]: string} */
+        city: Record<string, string>;
+        /** {[langIsoCode: string]: string} */
+        shortTitle: Record<string, string>;
+    };
+}
+
+export interface WebcamArchiveItem {
+    timestamp: number;
+    url: string;
+}
+
+export interface WebcamArchive {
+    day: WebcamArchiveItem[];
+    month: WebcamArchiveItem[];
+    year: WebcamArchiveItem[];
+    lifetime: WebcamArchiveItem[];
+}
+
+export type WebcamArchiveInterval = keyof WebcamArchive;
+
+export interface WebcamsData {
+    cams: WebcamDetail[];
+    total: number;
+}
+
+export type WebcamsPayload = HttpPayload<WebcamsData>;
+
+export interface WebcamsLoadingParams extends LatLon {
+    forceReload?: boolean;
+}
+
+export interface GeneralWcAdminResponse {
+    /** HTTP status code returned in response body */
+    code?: number;
+    status: 'FAILED' | 'OK';
+    /** Error or success message */
+    message: string | '';
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+}
+
+export interface WebcamLastUpdatedOn {
+    webcamId: number[];
+    lastUpdatedOn: number[];
+}
+
+export interface WebcamMetadata {
+    updateString: string;
+    recencyClass: string;
+    distanceString: string;
+}

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

@@ -0,0 +1,177 @@
+/*
+    Overall broadcasted events. We have used loose coupled components
+    system before TS was used.
+
+    Now it is better to use close coupled components, with strong type control
+
+
+    TODO: Minimize amount of these events and reduce their usage
+
+*/
+import { DetailLocChangeParams } from '@plugins/detail/detail.d';
+import { ClientMessage, DownloadProgress, ServiceWorkerMessage } from '@plugins/offline/offline';
+import { Evented } from '@windy/Evented';
+import { MetricIdent, MetricItem } from '@windy/Metric.d';
+import { Fav, GeolocationInfo, LatLon, WeatherParameters } from '@windy/interfaces.d';
+import { Pois } from '@windy/rootScope.d';
+import { ExtendedDataAndParams } from '@plugins/isolines/IsolinesCanvas2D.d';
+import { Poi as GlobePoi, Params as GlobeParams } from '@plugins/globe/types.d';
+import { ParsLocation as GlobeParsLocation } from '@plugins/globe/main/receiver.d';
+import { NotificationPreferences } from '@windy/dataSpecifications.d';
+import { PluginIdent } from '@windy/Plugin';
+import { PluginSource, PluginsOpenParams, PluginsQsParams } from '@windy/plugin-params.d';
+import { Plugins } from '@windy/plugins.d';
+import type { ExternalPluginIdent } from '@windy/types';
+
+type BcastTypesNonGeneric = {
+    /**
+     * @ignore
+     */
+    [key in `globe-poi-${Pois}`]: [HTMLElement | null, NonNullable<GlobePoi>];
+};
+
+/**
+ * # @windy/broadcast
+ *
+ *  Major Windy's event emitter (instance of class {@link Evented.Evented | Evented }), used for announcing the most important events.
+ *
+ * @example
+ * ```js
+ * import broadcast from '@windy/broadcast';
+ *
+ * const listener = params => console.log('Params has changed', params);
+ *
+ * broadcast.on('redrawFinished', listener );
+ *
+ * broadcast.once('metricChanged', params => {
+ *     // This method will be called just once
+ * });
+ *
+ * // Do not forget to unsubscribe any listener
+ * broadcast.off('redrawFinished', listener);
+ *
+ * // Let's fire some event
+ * broadcast.emit('rqstOpen', 'menu');
+ * ```
+ */
+export interface BasicBcastTypes<T extends keyof Plugins> {
+    /**
+     * Basically most important broadcast of all, triggered just once,
+     * when Windy.com has been successfully loaded and all modules are ready
+     * to be consumed
+     */
+    dependenciesResolved: [];
+
+    /** Request to open plugin (either internal or external) */
+    rqstOpen: [T | string, PluginsOpenParams[T] | undefined];
+
+    /** Request to close plugin (either internal or external) */
+    rqstClose: [T | string, MouseEvent | TouchEvent | KeyboardEvent | undefined];
+
+    /** Request to close all opened plugins (unless plugin has noClose property) */
+    closeAllPlugins: [PluginIdent] | [];
+
+    /** Plugin was successfully loaded and closed */
+    pluginClosed: [PluginIdent | string];
+
+    /** Plugin was succesfully closed */
+    pluginOpened: [PluginIdent | string];
+
+    /**
+     * Triggered when Windy has successfully loaded and rendered requested data.
+     * Use this for triggering your own tasks.
+     */
+    redrawFinished: [WeatherParameters | null];
+
+    /**
+     * Forces various renderers to render layers, for example after
+     * reconfiguring color gradient, or changing particle animation settings.
+     */
+    redrawLayers: [{ noCache: boolean }] | [];
+
+    /**
+     * When user changes some parameters (overlay, level, date etc...).
+     * Do not not use this event to start any intensive action since Windy now
+     * must load and render all the data. We recommend to use `redrawFinished` instead.
+     */
+    paramsChanged: [WeatherParameters, keyof WeatherParameters | undefined];
+
+    /**
+     * Indicates that user changed any of the units (wind, temp, ...).
+     */
+    metricChanged: [MetricIdent | undefined, MetricItem | undefined];
+
+    /** Indicates that user added, remover or rename his fav @ignore */
+    favChanged: [];
+
+    /**
+     * Indicates, that router has parsed URL and launched plugin
+     * that was requested in URL
+     */
+    routerParsed: [PluginIdent | ExternalPluginIdent | void];
+
+    // prettier-ignore
+    /** @ignore */ airportLoaded: [Fav];
+    /** @ignore */ globeOpened: [];
+    /** @ignore */ globeClose: [];
+    /** @ignore */ globeFailed: [];
+    /** @ignore */ 'globe-detail': [DetailLocChangeParams | (LatLon & PluginSource)];
+    /** @ignore */ 'globe-isolines': [ExtendedDataAndParams | null];
+    /** @ignore */ 'globe-poi': [GlobeParsLocation & { type?: string; id?: string }];
+    /** @ignore */ 'globe-zoomIn': [[number, number] | null] | [];
+    /** @ignore */ 'globe-zoomOut': [[number, number] | null] | [];
+    /** @ignore */ 'globe-paramsChanged': [GlobeParams];
+    /** @ignore */ 'maps-zoomIn': [number | undefined, L.ZoomOptions | undefined];
+    /** @ignore */ 'maps-zoomOut': [number | undefined, L.ZoomOptions | undefined];
+    /** @ignore */ 'maps-paramsChanged': [WeatherParameters, keyof WeatherParameters | undefined];
+    /** @ignore */ detailClose: [];
+    /** @ignore */ detailRendered: []; // used only in embed2
+    /** @ignore */ reloadFavs: [];
+    /** @ignore */ notifPrefChanged: [NotificationPreferences | undefined];
+    /** @ignore */ satBackupReload: [];
+    /** @ignore */ promptSavePassword: [];
+    /** @ignore */ screenshotReady: [];
+    /** @ignore */ screenshotError: [Error];
+    /** @ignore */ onResume: [];
+    /** @ignore */ cloudSync: ['error', { data: Fav | string; action: string; type: 'fav' }];
+    /** @ignore */ back2home: [];
+    /** @ignore */ reloadMobileApp: [];
+    /** @ignore */ newLocation: [GeolocationInfo];
+    /** @ignore */ checkPendingSubscriptions: [];
+    /** @ignore */ loadingFailed: [string];
+    /** @ignore */ zoomIn: [];
+    /** @ignore */ zoomOut: [];
+    /** @ignore */ userReloadInfo: [];
+    /** @ignore */ showSocialError: [string];
+    /** @ignore */ openCapAlerts: [PluginsOpenParams['picker']];
+    /** @ignore */ openapp: [];
+    /** @ignore */ openSearch: [];
+    /** @ignore */ offlineNativeMessage: [ClientMessage];
+    /** @ignore */ offlineClientMessage: [ServiceWorkerMessage | { data: DownloadProgress }];
+}
+
+interface BcastTypes<T extends keyof Plugins> extends BcastTypesNonGeneric, BasicBcastTypes<T> {}
+
+/** @ignore */
+export type BcastEventsWithoutParams<T extends keyof Plugins> = keyof Pick<
+    BcastTypes<T>,
+    { [K in keyof BcastTypes<T>]: [] extends BcastTypes<T>[K] ? K : never }[keyof BcastTypes<T>]
+>;
+
+/** @ignore */
+export class Broadcast extends Evented<BcastTypes<keyof Plugins>> {
+    // emitting `rqstOpen` is quite complicated for TS, simplify it with multiple definition
+    emit<K extends keyof Omit<BcastTypes<keyof Plugins>, 'rqstOpen'>>(
+        this: this,
+        topic: K,
+        ...data: TrimUndefinedFromRight<Arrayify<BcastTypes<keyof Plugins>[K]>>
+    ): void;
+
+    emit<P extends string>(
+        this: this,
+        topic: 'rqstOpen',
+        pluginName: P,
+        params?: PluginsOpenParams[P],
+        qs?: PluginsQsParams[P],
+    ): void;
+}