@skypath-io/web-sdk 0.5.31 → 1.0.0

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

@@ -25,6 +25,7 @@ export class AuthService {
         tokenProvider: {
             token: any;
         };
+        config: any;
     }>;
     #private;
 }

package/dist/types/src/core/auth/consts.d.ts

@@ -12,6 +12,7 @@ export namespace PATHS {
     let PARTNER_LOGIN_SIGNED: string;
     let PARTNER_REFRESH_TOKEN: string;
     let ME: string;
+    let CONFIG: string;
 }
 export const REQUEST_ABORTED_MESSAGE: "[SkyPath SDK]: Old fetch request aborted";
 export namespace ENVIRONMENTS {
@@ -31,3 +32,8 @@ export namespace NETWORK_ERROR_MESSAGES {
     let FIREFOX: string;
     let SAFARI: string;
 }
+export namespace CONFIG_KEYS {
+    let ONELAYER_WEB_IS_ENABLED: string;
+    let WEB_FORECAST_IS_ENABLED: string;
+    let GTG_IS_ENABLED: string;
+}

package/dist/types/src/core/monitoring/errors.d.ts

@@ -4,6 +4,7 @@ export namespace ERROR_MESSAGES {
     let FAILED_TO_AUTHENTICATE_WITH_AUTH_CALLBACK: string;
     let FAILED_TO_AUTHENTICATE_WITH_API_KEY: string;
     let FAILED_TO_GET_AUTH_TOKEN: string;
+    let FAILED_TO_FETCH_USER_CONFIG: string;
 }
 export class SkyPathError extends Error {
     /**

package/dist/types/src/features/{nowcasting → forecast}/consts.d.ts

@@ -1,4 +1,4 @@
-export namespace NOWCASTING_PATHS {
+export namespace FORECAST_PATHS {
     let INFO: string;
     let DATA: string;
 }
@@ -13,6 +13,7 @@ export const REFRESH_TIME_SEC: number;
 export namespace CONFIG_KEYS {
     let POLYGON: string;
     let IS_CORRIDOR_MODE: string;
+    let IS_ENABLED: string;
 }
 export const MAP_RESOLUTION: 5;
 export const MAX_FORECAST_HOURS: 24;

package/dist/types/src/features/{nowcasting → forecast}/flow.d.ts

@@ -1,4 +1,4 @@
-export class NowcastingFlow {
+export class ForecastFlow {
     constructor({ service, cacheTokenService }: {
         service: any;
         cacheTokenService: any;
@@ -10,9 +10,10 @@ export class NowcastingFlow {
     stop: () => void;
     terminate: () => void;
     get isRunning(): any;
-    updateConfig: ({ polygon, isCorridorMode, forecast, maxAltitude, minAltitude, minSeverity, }: {
+    updateConfig: ({ polygon, isCorridorMode, isEnabled, forecast, maxAltitude, minAltitude, minSeverity, }: {
         polygon: any;
         isCorridorMode: any;
+        isEnabled: any;
         forecast: any;
         maxAltitude: any;
         minAltitude: any;

package/dist/types/src/features/{nowcasting → forecast}/service.d.ts

@@ -1,4 +1,4 @@
-export class NowcastingService {
+export class ForecastService {
     constructor({ fetcher, isGtg }: {
         fetcher: any;
         isGtg?: boolean;

package/dist/types/src/features/{nowcasting → forecast}/utils.d.ts

@@ -1,7 +1,8 @@
-export function validateInput({ polygon, forecast, isCorridorMode, maxAltitude, minAltitude, minSeverity, }: {
+export function validateInput({ polygon, forecast, isCorridorMode, isEnabled, maxAltitude, minAltitude, minSeverity, }: {
     polygon: any;
     forecast: any;
     isCorridorMode: any;
+    isEnabled: any;
     maxAltitude: any;
     minAltitude: any;
     minSeverity: any;
@@ -31,7 +32,7 @@ export function filterData({ data, filters, childCells }: {
     filters: any;
     childCells: any;
 }): any;
-export function prepareNowcastingDataForMapHexagons({ data, resolution, }: {
+export function prepareForecastDataForMapHexagons({ data, resolution, }: {
     data: any;
     resolution?: number;
 }): any[];

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

@@ -18,10 +18,11 @@ export const REFRESH_TIME_SEC: number;
 export namespace CONFIG_KEYS {
     let POLYGON: string;
     let IS_CORRIDOR_MODE: string;
+    let IS_FORECAST_ENABLED: string;
     let AIRCRAFT_CATEGORY: string;
     let HOURS_AGO: string;
     let FORECAST_TS: string;
-    let NOWCASTING_ALT: string;
+    let FORECAST_ALT: string;
 }
 export namespace AIRCRAFT_CATEGORY {
     let C10: string;

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

@@ -1,8 +1,9 @@
 export class OneLayerFlow {
-    constructor({ fetcher, cacheTokenService, nowcastingService }: {
+    constructor({ fetcher, cacheTokenService, forecastService, isForecastActive, }: {
         fetcher: any;
         cacheTokenService: any;
-        nowcastingService: any;
+        forecastService: any;
+        isForecastActive: any;
     });
     onData: (callback: any) => void;
     onError: (callback: any) => void;
@@ -11,13 +12,14 @@ export class OneLayerFlow {
     stop: () => void;
     terminate: () => void;
     get isRunning(): any;
-    updateConfig: ({ polygon, isCorridorMode, aircraftCategory, hoursAgo, forecastTs, nowcastingAlt, maxAltitude, minAltitude, minSeverity, }: {
+    updateConfig: ({ polygon, isCorridorMode, isForecastEnabled, aircraftCategory, hoursAgo, forecastTs, forecastAlt, maxAltitude, minAltitude, minSeverity, }: {
         polygon: any;
         isCorridorMode: any;
+        isForecastEnabled: any;
         aircraftCategory: any;
         hoursAgo: any;
         forecastTs: any;
-        nowcastingAlt: any;
+        forecastAlt: any;
         maxAltitude: any;
         minAltitude: any;
         minSeverity: any;

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

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

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

@@ -1,13 +1,14 @@
-export function validateInput({ polygon, isCorridorMode, aircraftCategory, hoursAgo, maxAltitude, minAltitude, minSeverity, forecastTs, nowcastingAlt, }: {
+export function validateInput({ polygon, isCorridorMode, isForecastEnabled, aircraftCategory, hoursAgo, maxAltitude, minAltitude, minSeverity, forecastTs, forecastAlt, }: {
     polygon: any;
     isCorridorMode: any;
+    isForecastEnabled: any;
     aircraftCategory: any;
     hoursAgo: any;
     maxAltitude: any;
     minAltitude: any;
     minSeverity: any;
     forecastTs: any;
-    nowcastingAlt: any;
+    forecastAlt: any;
 }): void;
 export function mapPolygonToHexIds({ polygon, polygonSize }: {
     polygon: any;
@@ -25,22 +26,24 @@ export function margeDeltaReports({ oldReports, newReports }: {
  *
  * @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 {Object | null} [params.forecastData] - The forecast 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.hoursAgo] - The event expiration time in hours.
+ * @param {boolean} [params.options.isForecastEnabled] - is forecast layer return data.
  * @returns {Object} The result object.
  */
-export function storeToResult({ oneLayerStore, nowcastingData, selector, options, }: {
+export function storeToResult({ oneLayerStore, forecastData, selector, options: { childCells, forecastTs, hoursAgo, isForecastEnabled }, }: {
     oneLayerStore: Map<any, any>;
-    nowcastingData?: any | null;
+    forecastData?: any | null;
     selector: any[];
     options: {
         childCells?: any[];
         forecastTs: number;
         hoursAgo?: number | null;
+        isForecastEnabled?: boolean;
     };
 }): any;
 export function mapResponseToReportsArray({ responseData }: {
@@ -58,9 +61,9 @@ export function getMostRelevantTimeWindowReport({ reports, forecastTs, hoursAgo
 export function getForecastTs({ forecastTs }: {
     forecastTs: any;
 }): any;
-export function convertNowcastingDataToOnaLayerStructure({ hexId, nowcastItem }: {
+export function convertForecastDataToOneLayerStructure({ hexId, forecastItem }: {
     hexId: any;
-    nowcastItem: any;
+    forecastItem: any;
 }): {
     hexId: any;
     alt: any;

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

@@ -5,13 +5,29 @@ export * from "./publicApi";
  */
 export type SkyPathSDK = {
     /**
-     * - Factory function to create a NowcastingFlow instance.
+     * - Whether the forecast flow is available for this user.
      */
-    createNowcastingFlow: () => NowcastingFlow;
+    IS_FORECAST_ENABLED: boolean;
+    /**
+     * - Whether the one-layer flow is available for this user.
+     */
+    IS_ONELAYER_ENABLED: boolean;
+    /**
+     * - Whether the ADSB flow is available for this user.
+     */
+    IS_ADSB_ENABLED: boolean;
+    /**
+     * - Whether the GTG flow is available for this user.
+     */
+    IS_GTG_ENABLED: boolean;
+    /**
+     * - Factory function to create a ForecastFlow instance.
+     */
+    createForecastFlow: () => ForecastFlow;
     /**
      * - Factory function to create a createGtgFlow instance.
      */
-    createGtgFlow: () => NowcastingFlow;
+    createGtgFlow: () => ForecastFlow;
     /**
      * - Factory function to create an ObservationsFlow instance.
      */
@@ -66,8 +82,12 @@ 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 createGtgFlow instance.
+ * @property {boolean} IS_FORECAST_ENABLED - Whether the forecast flow is available for this user.
+ * @property {boolean} IS_ONELAYER_ENABLED - Whether the one-layer flow is available for this user.
+ * @property {boolean} IS_ADSB_ENABLED - Whether the ADSB flow is available for this user.
+ * @property {boolean} IS_GTG_ENABLED - Whether the GTG flow is available for this user.
+ * @property {() => ForecastFlow} createForecastFlow - Factory function to create a ForecastFlow instance.
+ * @property {() => ForecastFlow} 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.
@@ -85,12 +105,12 @@ export type SkyPathSDKOptions = {
  */
 /**
  * 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).
+ * for creating different flows (e.g. Forecast 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.
+ * @returns {Promise<SkyPathSDK>} - An object containing factory functions to create ForecastFlow, GTGFlow, ObservationsFlow or other flows.
  * @example
  * ```js
  * // Initialize the SkyPath SDK with the API key, user ID, and company name.
@@ -110,13 +130,13 @@ export type SkyPathSDKOptions = {
  * });
  *
  * // Use the factory functions to create different flows.
- * const nowcastingFlow = skyPathSDK.createNowcastingFlow();
+ * const forecastFlow = skyPathSDK.createForecastFlow();
  * const observationsFlow = skyPathSDK.createObservationsFlow();
  * const OneLayerFlow = skyPathSDK.createOneLayerFlow();
  * ```
  */
 declare function createSkyPathSDK({ apiKey, userId, companyName, authCallback, environment, proxyUrl, applicationId, isMonitoringEnabled, shouldCollectConsoleLogs, shouldCollectErrors, }: SkyPathSDKOptions): Promise<SkyPathSDK>;
-import { NowcastingFlow } from "./features/nowcasting";
+import { ForecastFlow } from "./features/forecast";
 import { ObservationsFlow } from "./features/observations";
 import { OneLayerFlow } from "./features/oneLayer";
 import { ADSBFlow } from "./features/adsb";

package/package.json

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