@skypath-io/web-sdk 0.4.23 → 0.4.24

package/dist/types/src/core/geo/geo.d.ts

@@ -152,19 +152,19 @@ export function clampCoordinates({ coordinate }: {
  * @param {Object} params - The parameters.
  * @param {Object} params.data - The hexagons data.
  * @param {Object} params.filters - The filters to apply.
- * @param {number} [params.filters.hoursAgo] - The number of hours ago to filter data.
- * @param {number} [params.filters.altitudeFrom] - The minimum altitude to filter data.
- * @param {number} [params.filters.altitudeTo] - The maximum altitude to filter data.
- * @param {number} [params.filters.severity] - The minimum severity to filter data.
+ * @param {number} [params.filters.historyHours] - The number of hours ago to filter data.
+ * @param {number} [params.filters.minAltitude] - The minimum altitude to filter data.
+ * @param {number} [params.filters.maxAltitude] - The maximum altitude to filter data.
+ * @param {number} [params.filters.minSeverity] - The minimum severity to filter data.
  * @returns {Object} The filtered hexagons data.
  */
 export function getHexagonsDataSlice({ data, filters }: {
     data: any;
     filters: {
-        hoursAgo?: number;
-        altitudeFrom?: number;
-        altitudeTo?: number;
-        severity?: number;
+        historyHours?: number;
+        minAltitude?: number;
+        maxAltitude?: number;
+        minSeverity?: number;
     };
 }): any;
 /**
@@ -173,18 +173,18 @@ export function getHexagonsDataSlice({ data, filters }: {
  * @param {Object} params - The parameters.
  * @param {Object} params.data - The hexagons data.
  * @param {Object} params.filters - The filters to apply.
- * @param {number} [params.filters.altitudeFrom] - The minimum altitude to filter data.
- * @param {number} [params.filters.altitudeTo] - The maximum altitude to filter data.
- * @param {number} [params.filters.severity] - The minimum severity to filter data.
+ * @param {number} [params.filters.minAltitude] - The minimum altitude to filter data.
+ * @param {number} [params.filters.maxAltitude] - The maximum altitude to filter data.
+ * @param {number} [params.filters.minSeverity] - The minimum severity to filter data.
  * @param {string} [params.filters.polygonSize] - The size of the polygon.
  * @returns {Object} The filtered hexagon data.
  */
 export function getOneLayerHexagonsDataSlice({ data, filters }: {
     data: any;
     filters: {
-        altitudeFrom?: number;
-        altitudeTo?: number;
-        severity?: number;
+        minAltitude?: number;
+        maxAltitude?: number;
+        minSeverity?: number;
         polygonSize?: string;
     };
 }): any;

package/dist/types/src/core/utils/utils.d.ts

@@ -125,3 +125,13 @@ export function mergeWithoutUndefined({ current, next }: {
     current: any;
     next: any;
 }): any;
+/**
+ + * Returns a severity level based on the EDR value.
+ + *
+ + * @param {Object} params - The parameters.
+ + * @param {number} params.edrValue - The EDR value to evaluate.
+ + * @returns {number} - The severity level (0-4).
+ + */
+export function getSeverityValueByEdrValue({ edrValue }: {
+    edrValue: number;
+}): number;

package/dist/types/src/features/cacheToken/service.d.ts

@@ -2,10 +2,8 @@ export class CacheTokenService {
     constructor({ fetcher }: {
         fetcher: any;
     });
-    getToken: () => Promise<any>;
-    checkToken: (token: {
-        expireAt: string;
-        token: string;
-    }) => boolean;
+    start: () => void;
+    stop: () => void;
+    getToken: () => any;
     #private;
 }

package/dist/types/src/features/nowcasting/consts.d.ts

@@ -1,19 +1,20 @@
-export const DEFAULT_INTERVAL_TIME_MS: number;
-export const DEFAULT_MAP_DISPLAY_RESOLUTION: 5;
-export namespace PATHS {
+export namespace NOWCASTING_PATHS {
     let INFO: string;
     let DATA: string;
 }
-export namespace INTERNAL_EVENTS {
+export namespace GTG_PATHS {
+    let INFO_1: string;
+    export { INFO_1 as INFO };
     let DATA_1: string;
     export { DATA_1 as DATA };
-    export let UPDATE_CONFIG: string;
-    export let UPDATE_INTERVAL: string;
-    export let LOAD_NOWCASTING_DATA: string;
-    export let IS_PENDING_CHANGE: string;
 }
-export namespace DEFAULT_FILTER_VALUES {
-    let FORECAST: number;
-    let SEVERITY: number;
-    let ALTITUDE: number;
+export const DEBOUNCE_TIME_SEC: number;
+export const REFRESH_TIME_SEC: number;
+export namespace CONFIG_KEYS {
+    let POLYGON: string;
 }
+export const MAX_ALT: 52;
+export const MIN_ALT: 5;
+export const MAP_RESOLUTION: 5;
+export const FORECAST_RANGE: number[];
+export const SEVERITY_RANGE: number[];

package/dist/types/src/features/nowcasting/flow.d.ts

@@ -1,55 +1,21 @@
-/**
- * Nowcasting Flow is a class that manages the flow of fetching nowcasting data.
- *
- * @class
- * @param {Object} options
- * @param {Object} options.cacheTokenService - Cache token service instance
- * @param {Object} options.nowcastingService - Nowcasting service instance
- * @example
- * ```javascript
- * const nowcastingFlow = new NowcastingFlow({
- *  cacheTokenService,
- *  nowcastingService,
- * });
- *
- * nowcastingFlow.onData(console.log);
- *
- * nowcastingFlow.start();
- * nowcastingFlow.updateConfig({ hexIds });
- * nowcastingFlow.stop();
- * nowcastingFlow.terminate();
- * ```
- */
 export class NowcastingFlow {
-    constructor({ cacheTokenService, nowcastingService }: {
+    constructor({ service, cacheTokenService }: {
+        service: any;
         cacheTokenService: any;
-        nowcastingService: any;
     });
-    /**
-     * Subscribe to Nowcasting Flow new data
-     *
-     * @param {Function} listener - Listener function
-     */
-    onData: (listener: Function) => void;
-    updateConfig: (config?: {}) => void;
-    onChangeIsPending: (listener: any) => void;
-    /**
-     * Start the Nowcasting Flow. Initiates the flow of fetching nowcasting data. Setup listeners and execute the flow.
-     *
-     * @param {Object} options
-     * @param {string[]} [options.hexIds] - Hex IDs for initial nowcasting data fetching
-     */
-    start(): void;
-    /**
-     * Stop the Nowcasting Flow. Stops the flow of fetching nowcasting data.
-     * No resources are cleaned up. Just stops updating the data.
-     */
-    stop(): void;
-    /**
-     * Terminate the Nowcasting Flow. Terminates the flow of fetching nowcasting data.
-     * Cleans up all the resources and listeners.
-     */
-    terminate(): void;
-    getState: () => string;
+    onData: (callback: any) => void;
+    onError: (callback: any) => void;
+    onIsProcessingChange: (callback: any) => void;
+    start: () => void;
+    stop: () => void;
+    terminate: () => void;
+    get isRunning(): any;
+    updateConfig: ({ polygon, forecast, maxAltitude, minAltitude, minSeverity, }: {
+        polygon: any;
+        forecast: any;
+        maxAltitude: any;
+        minAltitude: any;
+        minSeverity: any;
+    }) => void;
     #private;
 }

package/dist/types/src/features/nowcasting/service.d.ts

@@ -1,13 +1,22 @@
 export class NowcastingService {
-    constructor({ fetcher }: {
+    constructor({ fetcher, isGtg }: {
         fetcher: any;
+        isGtg?: boolean;
     });
-    getInfo(): Promise<any>;
-    getData({ resolution, hexId, lastUpdatedAt, token }: {
-        resolution: any;
-        hexId: any;
-        lastUpdatedAt: any;
+    fetch: ({ config, signal, token }: {
+        config: any;
+        signal: any;
         token: any;
-    }): Promise<any>;
+    }) => Promise<void>;
+    getData: ({ config, filters }: {
+        config: any;
+        filters: any;
+    }) => {
+        toRawObject: () => any;
+        toHexagonsArray: () => any[];
+        toFeatureCollection: () => any;
+    };
+    expire: () => void;
+    dispose: () => void;
     #private;
 }

package/dist/types/src/features/nowcasting/utils.d.ts

@@ -1,82 +1,32 @@
-export type NowcastingItem = {
-    /**
-     * - Altitude level.
-     */
-    alt: number;
-    /**
-     * - Severity level.
-     */
-    sev: number;
-    /**
-     * - Forecast accuracy.
-     */
-    forecast: number;
-    /**
-     * - Array of hexagonal identifiers.
-     */
-    hexIds: Array<number>;
+export function validateInput({ polygon, forecast, maxAltitude, minAltitude, minSeverity, }: {
+    polygon: any;
+    forecast: any;
+    maxAltitude: any;
+    minAltitude: any;
+    minSeverity: any;
+}): void;
+export function mapPolygonToHexIds({ polygon, polygonSize }: {
+    polygon: any;
+    polygonSize: any;
+}): {
+    hexIds: string[];
 };
-export type NowcastingData = Record<string, Array<NowcastingItem>>;
-/**
- * Filters for slicing nowcasting data.
- */
-export type FilterCriteria = {
-    /**
-     * - Forecast filter.
-     */
-    forecast: number;
-    /**
-     * - Severity filter.
-     */
-    severity: number;
-    /**
-     * - Altitude filter.
-     */
-    altitude: number;
+export function mapResponseToReportsArray(response: any): any;
+export function buildData(data: any): {
+    toRawObject: () => any;
+    toHexagonsArray: () => any[];
+    toFeatureCollection: () => any;
 };
-/**
- * @typedef {Object} NowcastingItem
- * @property {number} alt - Altitude level.
- * @property {number} sev - Severity level.
- * @property {number} forecast - Forecast accuracy.
- * @property {Array<number>} hexIds - Array of hexagonal identifiers.
- */
-/**
- * @typedef {Record<string, Array<NowcastingItem>>} NowcastingData
- */
-/**
- * Filters for slicing nowcasting data.
- * @typedef {Object} FilterCriteria
- * @property {number} forecast - Forecast filter.
- * @property {number} severity - Severity filter.
- * @property {number} altitude - Altitude filter.
- */
-/**
- * Get a slice of the nowcasting data based on the filters.
- *
- * @param {Object} props - The props object containing data and filters.
- * @param {NowcastingData} props.data - The nowcasting data to slice.
- * @param {FilterCriteria} props.filters - The filters to apply.
- * @returns {NowcastingData} - The sliced/filtered nowcasting data.
- */
-export function getNowcastingDataSlice({ data, filters }: {
-    data: NowcastingData;
-    filters: FilterCriteria;
-}): NowcastingData;
-/**
- * Prepare the nowcasting data for the map hexagons.
- *
- * @param {Object} props - The props object containing data and resolution.
- * @param {NowcastingData} props.data - The nowcasting data to prepare.
- * @param {number} props.resolution - The resolution of the map display.
- * @returns {Array<{alt: number, sev: number, forecast: number, hexId: string}>} - Nowcasting data prepared for the map hexagons.
- */
+export function filterData({ data, filters }: {
+    data: any;
+    filters: any;
+}): any;
 export function prepareNowcastingDataForMapHexagons({ data, resolution, }: {
-    data: NowcastingData;
-    resolution: number;
-}): Array<{
-    alt: number;
-    sev: number;
-    forecast: number;
-    hexId: string;
-}>;
+    data: any;
+    resolution?: number;
+}): any[];
+export function getRelevantHexIds({ hexIds, data, currentLastUpdatedAt }: {
+    hexIds: any;
+    data: any;
+    currentLastUpdatedAt: any;
+}): any;

package/dist/types/src/features/oneLayer/flow.d.ts

@@ -1,6 +1,8 @@
 export class OneLayerFlow {
-    constructor({ fetcher }: {
+    constructor({ fetcher, cacheTokenService, nowcastingService }: {
         fetcher: any;
+        cacheTokenService: any;
+        nowcastingService: any;
     });
     onData: (callback: any) => void;
     onError: (callback: any) => void;

package/dist/types/src/features/oneLayer/service.d.ts

@@ -6,9 +6,10 @@ export class OneLayerService {
         config: any;
         signal: any;
     }) => Promise<any>;
-    getData: ({ config, filters }: {
+    getData: ({ config, filters, nowcastingData }: {
         config: any;
         filters: any;
+        nowcastingData: any;
     }) => {
         toRawObject: () => any;
         toHexagonsArray: () => any[];

package/dist/types/src/features/oneLayer/utils.d.ts

@@ -30,7 +30,6 @@ export function margeDeltaReports({ oldReports, newReports }: {
  * @param {Object} params.options - Additional options.
  * @param {Array} [params.options.childCells] - The child cells.
  * @param {number} params.options.forecastTs - The forecast timestamp.
- * @param {number | null} [params.options.nowcastingAlt] - The nowcasting altitude.
  * @param {number | null} [params.options.hoursAgo] - The event expiration time in hours.
  * @returns {Object} The result object.
  */
@@ -41,7 +40,6 @@ export function storeToResult({ oneLayerStore, nowcastingData, selector, options
     options: {
         childCells?: any[];
         forecastTs: number;
-        nowcastingAlt?: number | null;
         hoursAgo?: number | null;
     };
 }): any;
@@ -60,11 +58,6 @@ export function getMostRelevantTimeWindowReport({ reports, forecastTs, hoursAgo
 export function getForecastTs({ forecastTs }: {
     forecastTs: any;
 }): any;
-export function getNowcastViaForecastTsAndAlt({ nowcasting, forecastTs, nowcastingAlt, }: {
-    nowcasting: any;
-    forecastTs: any;
-    nowcastingAlt: any;
-}): any;
 export function convertNowcastingDataToOnaLayerStructure({ hexId, nowcastItem }: {
     hexId: any;
     nowcastItem: any;

package/dist/types/src/index.d.ts

@@ -9,7 +9,7 @@ export type SkyPathSDK = {
      */
     createNowcastingFlow: () => NowcastingFlow;
     /**
-     * - Factory function to create a GTGFlow instance.
+     * - Factory function to create a createGtgFlow instance.
      */
     createGtgFlow: () => NowcastingFlow;
     /**
@@ -67,7 +67,7 @@ export type SkyPathSDKOptions = {
  * The SkyPath SDK object containing factory functions to create different flows.
  * @typedef {Object} SkyPathSDK
  * @property {() => NowcastingFlow} createNowcastingFlow - Factory function to create a NowcastingFlow instance.
- * @property {() => NowcastingFlow} createGtgFlow - Factory function to create a GTGFlow instance.
+ * @property {() => NowcastingFlow} createGtgFlow - Factory function to create a createGtgFlow instance.
  * @property {() => ObservationsFlow} createObservationsFlow - Factory function to create an ObservationsFlow instance.
  * @property {() => OneLayerFlow} createOneLayerFlow - Factory function to create an OneLayerFlow instance.
  * @property {() => ADSBFlow} createAdsbFlow - Factory function to create an ADSBFlow instance.
@@ -111,9 +111,8 @@ export type SkyPathSDKOptions = {
  *
  * // Use the factory functions to create different flows.
  * const nowcastingFlow = skyPathSDK.createNowcastingFlow();
- * const gtgFlow = skyPathSDK.createGtgFlow();
  * const observationsFlow = skyPathSDK.createObservationsFlow();
- * const observationsFlow = skyPathSDK.createOneLayerFlow();
+ * const OneLayerFlow = skyPathSDK.createOneLayerFlow();
  * ```
  */
 declare function createSkyPathSDK({ apiKey, userId, companyName, authCallback, environment, proxyUrl, applicationId, isMonitoringEnabled, shouldCollectConsoleLogs, shouldCollectErrors, }: SkyPathSDKOptions): Promise<SkyPathSDK>;

package/dist/types/src/publicApi.d.ts

@@ -1,9 +1,5 @@
 import * as CoreUtils from "./core/utils";
 import * as GeoUtils from "./core/geo";
-export namespace Nowcasting {
-    export { getNowcastingDataSlice };
-    export { prepareNowcastingDataForMapHexagons };
-}
 export namespace Observations {
     namespace availableConfigInputs {
         export { AIRCRAFT_CATEGORY as aircraftCategory };
@@ -14,8 +10,6 @@ export namespace Observations {
         export { LARGE_POLYGON_HANDLING_BEHAVIOR as largePolygonHandlingBehavior };
     }
 }
-import { getNowcastingDataSlice } from "./features/nowcasting/utils";
-import { prepareNowcastingDataForMapHexagons } from "./features/nowcasting/utils";
 import { AIRCRAFT_CATEGORY } from "./features/observations/consts.js";
 import { HISTORY_HOURS } from "./features/observations/consts.js";
 import { SEVERITY } from "./features/observations/consts.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skypath-io/web-sdk",
-  "version": "0.4.23",
+  "version": "0.4.24",
   "type": "module",
   "main": "dist/bundle.cjs.js",
   "module": "dist/bundle.es.js",

package/dist/types/src/features/gtg/consts.d.ts

@@ -1,4 +0,0 @@
-export namespace PATHS {
-    let INFO: string;
-    let DATA: string;
-}

package/dist/types/src/features/gtg/index.d.ts

@@ -1 +0,0 @@
-export * from "./service";

package/dist/types/src/features/gtg/service.d.ts

@@ -1,13 +0,0 @@
-export class GtgService {
-    constructor({ fetcher }: {
-        fetcher: any;
-    });
-    getInfo(): Promise<any>;
-    getData({ resolution, hexId, lastUpdatedAt, token }: {
-        resolution: any;
-        hexId: any;
-        lastUpdatedAt: any;
-        token: any;
-    }): Promise<any>;
-    #private;
-}

package/dist/types/src/features/gtg/utils.d.ts

@@ -1,3 +0,0 @@
-export function getSeverityValueByEdrValue({ edrValue }: {
-    edrValue: any;
-}): 0 | 1 | 2 | 3 | 4;