@skypath-io/web-sdk 0.4.7 → 0.4.13

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

@@ -0,0 +1,55 @@
+/**
+ * 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 }: {
+        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;
+    #private;
+}

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

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

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

@@ -0,0 +1,13 @@
+export class NowcastingService {
+    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/nowcasting/utils.d.ts

@@ -0,0 +1,82 @@
+export type NowcastingItem = {
+    /**
+     * - Altitude level.
+     */
+    alt: number;
+    /**
+     * - Severity level.
+     */
+    sev: number;
+    /**
+     * - Forecast accuracy.
+     */
+    forecast: number;
+    /**
+     * - Array of hexagonal identifiers.
+     */
+    hexIds: Array<number>;
+};
+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;
+};
+/**
+ * @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 prepareNowcastingDataForMapHexagons({ data, resolution, }: {
+    data: NowcastingData;
+    resolution: number;
+}): Array<{
+    alt: number;
+    sev: number;
+    forecast: number;
+    hexId: string;
+}>;

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

@@ -0,0 +1,73 @@
+export namespace PATHS {
+    let DATA: string;
+}
+export namespace DEFAULT_FILTER_VALUES {
+    let HOURS_AGO: number;
+    let SEVERITY: number;
+    let ALT_FROM: number;
+    let ALT_TO: number;
+}
+export const SIZE_TO_RESOLUTION_MAP: {
+    [x: string]: number;
+};
+export const SIZE_TO_MIN_SEVERITY_MAP: {
+    [x: string]: number;
+};
+export const SIZE_TO_EXTENSION_FACTOR_MAP: {
+    [x: string]: number;
+};
+export const DEBOUNCE_TIME_SEC: number;
+export const REFRESH_TIME_SEC: number;
+export namespace CONFIG_KEYS {
+    let POLYGON: string;
+    let IS_CORRIDOR_MODE: string;
+    let AIRCRAFT_CATEGORY: string;
+}
+export namespace AIRCRAFT_CATEGORY {
+    let C10: string;
+    let C20: string;
+    let C30: string;
+    let C40: string;
+    let C50: string;
+    let C60: string;
+    let C70: string;
+    let C80: string;
+    let C90: string;
+    let C100: string;
+    let C110: string;
+}
+export namespace HISTORY_HOURS {
+    let halfAnHour: string;
+    let oneHour: string;
+    let twoHours: string;
+    let threeHours: string;
+    let fourHours: string;
+}
+export namespace SEVERITY {
+    let smooth: number;
+    let light: number;
+    let lightModerate: number;
+    let moderate: number;
+    let moderateSevere: number;
+}
+export const MAX_ALT: 52;
+export const MIN_ALT: 5;
+export const UPDATE_INTERVAL_MS: number;
+export const GLOBAL_OBSERVATION_DATA_EXPIRY_SEC: number;
+export const HEXAGON_OBSERVATION_DATA_EXPIRY_MS: number;
+export const DEFAULT_RESOLUTION: 1;
+export const MAP_RESOLUTION: 5;
+export namespace FLOW_OPERATION_MODES {
+    let DEFAULT: string;
+    let CORRIDOR: string;
+}
+export namespace LARGE_POLYGON_HANDLING_BEHAVIOR {
+    let IGNORE: string;
+    let USE_MIDDLE_AREA: string;
+    let EXCLUDE_SMOOTH_SEVERITY: string;
+}
+export const MIDDLE_AREA_EXTENSION_FACTOR: 4;
+export namespace ZOOM_LEVEL_THRESHOLDS {
+    let PREVENT_FETCHING: number;
+    let LARGE_POLYGON_FETCHING: number;
+}

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

@@ -0,0 +1,18 @@
+export class ObservationsFlow {
+    constructor({ fetcher }: {
+        fetcher: any;
+    });
+    onData: (callback: any) => void;
+    onError: (callback: any) => void;
+    onIsProcessingChange: (callback: any) => void;
+    start: () => void;
+    stop: () => void;
+    terminate: () => void;
+    get isRunning(): any;
+    updateConfig: ({ polygon, isCorridorMode, aircraftCategory }: {
+        polygon: any;
+        isCorridorMode: any;
+        aircraftCategory: any;
+    }) => void;
+    #private;
+}

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

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

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

@@ -0,0 +1,13 @@
+export class ObservationsService {
+    constructor({ fetcher }: {
+        fetcher: any;
+    });
+    fetch: ({ polygon, polygonSize, aircraftCategory }: {
+        polygon: any;
+        polygonSize: any;
+        aircraftCategory: any;
+    }, signal: any) => Promise<any>;
+    expire: () => void;
+    dispose: () => void;
+    #private;
+}

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

@@ -0,0 +1,15 @@
+export function validateInput({ polygon, isCorridorMode, aircraftCategory }: {
+    polygon: any;
+    isCorridorMode: any;
+    aircraftCategory: any;
+}): void;
+export function mapPolygonToHexIds({ polygon, polygonSize }: {
+    polygon: any;
+    polygonSize: any;
+}): {
+    hexIds: string[];
+    childCells: string[];
+};
+export function mapReportsArrayToReportsObject(reports: any): any;
+export function storeToResult(store: any, selector: any, options?: {}): any;
+export function mapResponseToReportsArray(response: any): any;

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

@@ -0,0 +1,76 @@
+export namespace PATHS {
+    let DATA: string;
+}
+export namespace DEFAULT_FILTER_VALUES {
+    let HOURS_AGO: number;
+    let SEVERITY: number;
+    let ALT_FROM: number;
+    let ALT_TO: number;
+}
+export const SIZE_TO_RESOLUTION_MAP: {
+    [x: string]: number;
+};
+export const SIZE_TO_MIN_SEVERITY_MAP: {
+    [x: string]: number;
+};
+export const SIZE_TO_EXTENSION_FACTOR_MAP: {
+    [x: string]: number;
+};
+export const DEBOUNCE_TIME_SEC: number;
+export const REFRESH_TIME_SEC: number;
+export namespace CONFIG_KEYS {
+    export let POLYGON: string;
+    export let IS_CORRIDOR_MODE: string;
+    export let AIRCRAFT_CATEGORY: string;
+    let HOURS_AGO_1: string;
+    export { HOURS_AGO_1 as HOURS_AGO };
+    export let FORECAST_TS: string;
+    export let NOWCASTING_ALT: string;
+}
+export namespace AIRCRAFT_CATEGORY {
+    let C10: string;
+    let C20: string;
+    let C30: string;
+    let C40: string;
+    let C50: string;
+    let C60: string;
+    let C70: string;
+    let C80: string;
+    let C90: string;
+    let C100: string;
+    let C110: string;
+}
+export namespace HISTORY_HOURS {
+    let halfAnHour: string;
+    let oneHour: string;
+    let twoHours: string;
+    let fourHours: string;
+}
+export namespace SEVERITY {
+    let smooth: number;
+    let light: number;
+    let lightModerate: number;
+    let moderate: number;
+    let moderateSevere: number;
+}
+export const MAX_ALT: 52;
+export const MIN_ALT: 5;
+export const UPDATE_INTERVAL_MS: number;
+export const GLOBAL_OBSERVATION_DATA_EXPIRY_SEC: number;
+export const HEXAGON_OBSERVATION_DATA_EXPIRY_MS: number;
+export const DEFAULT_RESOLUTION: 1;
+export const MAP_RESOLUTION: 5;
+export namespace FLOW_OPERATION_MODES {
+    let DEFAULT: string;
+    let CORRIDOR: string;
+}
+export namespace LARGE_POLYGON_HANDLING_BEHAVIOR {
+    let IGNORE: string;
+    let USE_MIDDLE_AREA: string;
+    let EXCLUDE_SMOOTH_SEVERITY: string;
+}
+export const MIDDLE_AREA_EXTENSION_FACTOR: 4;
+export namespace ZOOM_LEVEL_THRESHOLDS {
+    let PREVENT_FETCHING: number;
+    let LARGE_POLYGON_FETCHING: number;
+}

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

@@ -0,0 +1,21 @@
+export class OneLayerFlow {
+    constructor({ fetcher }: {
+        fetcher: any;
+    });
+    onData: (callback: any) => void;
+    onError: (callback: any) => void;
+    onIsProcessingChange: (callback: any) => void;
+    start: () => void;
+    stop: () => void;
+    terminate: () => void;
+    get isRunning(): any;
+    updateConfig: ({ polygon, isCorridorMode, aircraftCategory, hoursAgo, forecastTs, nowcastingAlt, }: {
+        polygon: any;
+        isCorridorMode: any;
+        aircraftCategory: any;
+        hoursAgo: any;
+        forecastTs: any;
+        nowcastingAlt: any;
+    }) => void;
+    #private;
+}

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

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

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

@@ -0,0 +1,19 @@
+export class OneLayerService {
+    constructor({ fetcher }: {
+        fetcher: any;
+    });
+    fetch: ({ polygon, polygonSize, aircraftCategory, hoursAgo, forecastTs, nowcastingAlt, shouldIgnorePromises, }: {
+        polygon: any;
+        polygonSize: any;
+        aircraftCategory: any;
+        hoursAgo: any;
+        forecastTs: any;
+        nowcastingAlt: any;
+        shouldIgnorePromises: any;
+    }, signal: any) => Promise<any>;
+    expire: ({ hoursAgo }: {
+        hoursAgo: any;
+    }) => void;
+    dispose: () => void;
+    #private;
+}

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

@@ -0,0 +1,79 @@
+export function validateInput({ polygon, isCorridorMode, aircraftCategory, hoursAgo, forecastTs, nowcastingAlt, }: {
+    polygon: any;
+    isCorridorMode: any;
+    aircraftCategory: any;
+    hoursAgo: any;
+    forecastTs: any;
+    nowcastingAlt: any;
+}): void;
+export function mapPolygonToHexIds({ polygon, polygonSize }: {
+    polygon: any;
+    polygonSize: any;
+}): {
+    hexIds: string[];
+    childCells: string[];
+};
+export function margeDeltaReports({ oldReports, newReports }: {
+    oldReports: any;
+    newReports: any;
+}): any[];
+/**
+ * Converts the store data to a result object.
+ *
+ * @param {Object} params - The parameters.
+ * @param {Map} params.oneLayerStore - The store containing one layer data.
+ * @param {Object | null} [params.nowcastingData] - The nowcasting response data.
+ * @param {Array} params.selector - The selector array.
+ * @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.
+ */
+export function storeToResult({ oneLayerStore, nowcastingData, selector, options, }: {
+    oneLayerStore: Map<any, any>;
+    nowcastingData?: any | null;
+    selector: any[];
+    options: {
+        childCells?: any[];
+        forecastTs: number;
+        nowcastingAlt?: number | null;
+        hoursAgo?: number | null;
+    };
+}): any;
+export function mapResponseToReportsArray({ responseData }: {
+    responseData: any;
+}): any;
+export function expireOldData({ store, hoursAgo }: {
+    store: any;
+    hoursAgo: any;
+}): Map<any, any>;
+export function getMostRelevantTimeWindowReport({ reports, forecastTs, hoursAgo }: {
+    reports: any;
+    forecastTs: any;
+    hoursAgo: any;
+}): any;
+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;
+}): {
+    hexId: any;
+    alt: any;
+    severities: {
+        edr: any;
+        sev: any;
+        sources: number[];
+        observationTime: number;
+        usedSource: number;
+        usedSourceTs: number;
+    }[];
+};

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

@@ -0,0 +1,123 @@
+export default createSkyPathSDK;
+export * from "./publicApi";
+/**
+ * The SkyPath SDK object containing factory functions to create different flows.
+ */
+export type SkyPathSDK = {
+    /**
+     * - Factory function to create a NowcastingFlow instance.
+     */
+    createNowcastingFlow: () => NowcastingFlow;
+    /**
+     * - Factory function to create a GTGFlow instance.
+     */
+    createGtgFlow: () => NowcastingFlow;
+    /**
+     * - Factory function to create an ObservationsFlow instance.
+     */
+    createObservationsFlow: () => ObservationsFlow;
+    /**
+     * - Factory function to create an OneLayerFlow instance.
+     */
+    createOneLayerFlow: () => OneLayerFlow;
+    /**
+     * - Factory function to create an ADSBFlow instance.
+     */
+    createAdsbFlow: () => ADSBFlow;
+    /**
+     * - Converts an aircraft ICAO code to an aircraft type.
+     */
+    mapAircraftIcaoToAircraftType: (options: {
+        icao: string;
+    }) => string;
+};
+/**
+ * Options to initialize the SkyPath SDK.
+ */
+export type SkyPathSDKOptions = {
+    /**
+     * - The Proxy URL to make API requests.
+     */
+    proxyUrl?: string;
+    /**
+     * - Authentication API key.
+     */
+    apiKey?: string;
+    /**
+     * - User ID.
+     */
+    userId?: string;
+    /**
+     * - Company name.
+     */
+    companyName?: string;
+    /**
+     * - The environment to initialize the SDK (default: "staging").
+     */
+    environment?: string;
+    /**
+     * - The callback function to authenticate with signed JWT.
+     */
+    authCallback?: () => Promise<{
+        jwt: string;
+        partnerId: string;
+    }>;
+};
+/**
+ * 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 {() => 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.
+ * @property {(options: { icao: string }) => string} mapAircraftIcaoToAircraftType - Converts an aircraft ICAO code to an aircraft type.
+ */
+/**
+ * Options to initialize the SkyPath SDK.
+ * @typedef {Object} SkyPathSDKOptions
+ * @property {string} [proxyUrl] - The Proxy URL to make API requests.
+ * @property {string} [apiKey] - Authentication API key.
+ * @property {string} [userId] - User ID.
+ * @property {string} [companyName] - Company name.
+ * @property {string} [environment] - The environment to initialize the SDK (default: "staging").
+ * @property {() => Promise<{ jwt: string, partnerId: string }>} [authCallback] - The callback function to authenticate with signed JWT.
+ */
+/**
+ * Initializes the SkyPath SDK and returns a promise that resolves to an object with factory functions
+ * for creating different flows (e.g. Nowcasting or Observations).
+ *
+ * @async
+ * @function createSkyPathSDK
+ * @param {SkyPathSDKOptions} options - The options to initialize the SDK.
+ * @returns {Promise<SkyPathSDK>} - An object containing factory functions to create NowcastingFlow, GTGFlow, ObservationsFlow or other flows.
+ * @example
+ * ```js
+ * // Initialize the SkyPath SDK with the API key, user ID, and company name.
+ * const skyPathSDK = await createSkyPathSDK({
+ *  apiKey: "YOUR_API_KEY",
+ *  userId: "YOUR_USER_ID",
+ *  companyName: "YOUR_COMPANY_NAME",
+ * });
+ *
+ * // Alternatively, you can use the authCallback function to authenticate with signed JWT.
+ * const skyPathSDK = await createSkyPathSDK({
+ *  authCallback: async () => {
+ *   return {
+ *    jwt: "YOUR_SIGNED_JWT",
+ *    partnerId: "YOUR_PARTNER_ID",
+ *  };
+ * });
+ *
+ * // Use the factory functions to create different flows.
+ * const nowcastingFlow = skyPathSDK.createNowcastingFlow();
+ * const gtgFlow = skyPathSDK.createGtgFlow();
+ * const observationsFlow = skyPathSDK.createObservationsFlow();
+ * const observationsFlow = skyPathSDK.createOneLayerFlow();
+ * ```
+ */
+declare function createSkyPathSDK({ apiKey, userId, companyName, authCallback, environment, proxyUrl, applicationId, isMonitoringEnabled, shouldCollectConsoleLogs, shouldCollectErrors, }: SkyPathSDKOptions): Promise<SkyPathSDK>;
+import { NowcastingFlow } from "./features/nowcasting";
+import { ObservationsFlow } from "./features/observations";
+import { OneLayerFlow } from "./features/oneLayer";
+import { ADSBFlow } from "./features/adsb";

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

@@ -0,0 +1,25 @@
+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 };
+        export { HISTORY_HOURS as hours };
+        export { SEVERITY as severity };
+        export { MAX_ALT as maxAltitude };
+        export { MIN_ALT as minAltitude };
+        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";
+import { MAX_ALT } from "./features/observations/consts.js";
+import { MIN_ALT } from "./features/observations/consts.js";
+import { LARGE_POLYGON_HANDLING_BEHAVIOR } from "./features/observations/consts.js";
+export { CoreUtils, GeoUtils };