@skypath-io/web-sdk 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +115 -24
- package/dist/bundle.cjs.js +2 -2
- package/dist/bundle.es.js +2 -2
- package/dist/bundle.iife.js +2 -2
- package/dist/types/src/core/auth/consts.d.ts +0 -1
- package/dist/types/src/features/forecast/consts.d.ts +0 -6
- package/dist/types/src/features/forecast/service.d.ts +1 -2
- package/dist/types/src/index.d.ts +1 -11
- package/package.json +1 -1
|
@@ -2,12 +2,6 @@ export namespace FORECAST_PATHS {
|
|
|
2
2
|
let INFO: string;
|
|
3
3
|
let DATA: string;
|
|
4
4
|
}
|
|
5
|
-
export namespace GTG_PATHS {
|
|
6
|
-
let INFO_1: string;
|
|
7
|
-
export { INFO_1 as INFO };
|
|
8
|
-
let DATA_1: string;
|
|
9
|
-
export { DATA_1 as DATA };
|
|
10
|
-
}
|
|
11
5
|
export const DEBOUNCE_TIME_SEC: number;
|
|
12
6
|
export const REFRESH_TIME_SEC: number;
|
|
13
7
|
export namespace CONFIG_KEYS {
|
|
@@ -16,18 +16,10 @@ export type SkyPathSDK = {
|
|
|
16
16
|
* - Whether the ADSB flow is available for this user.
|
|
17
17
|
*/
|
|
18
18
|
IS_ADSB_ENABLED: boolean;
|
|
19
|
-
/**
|
|
20
|
-
* - Whether the GTG flow is available for this user.
|
|
21
|
-
*/
|
|
22
|
-
IS_GTG_ENABLED: boolean;
|
|
23
19
|
/**
|
|
24
20
|
* - Factory function to create a ForecastFlow instance.
|
|
25
21
|
*/
|
|
26
22
|
createForecastFlow: () => ForecastFlow;
|
|
27
|
-
/**
|
|
28
|
-
* - Factory function to create a createGtgFlow instance.
|
|
29
|
-
*/
|
|
30
|
-
createGtgFlow: () => ForecastFlow;
|
|
31
23
|
/**
|
|
32
24
|
* - Factory function to create an ObservationsFlow instance.
|
|
33
25
|
*/
|
|
@@ -85,9 +77,7 @@ export type SkyPathSDKOptions = {
|
|
|
85
77
|
* @property {boolean} IS_FORECAST_ENABLED - Whether the forecast flow is available for this user.
|
|
86
78
|
* @property {boolean} IS_ONELAYER_ENABLED - Whether the one-layer flow is available for this user.
|
|
87
79
|
* @property {boolean} IS_ADSB_ENABLED - Whether the ADSB flow is available for this user.
|
|
88
|
-
* @property {boolean} IS_GTG_ENABLED - Whether the GTG flow is available for this user.
|
|
89
80
|
* @property {() => ForecastFlow} createForecastFlow - Factory function to create a ForecastFlow instance.
|
|
90
|
-
* @property {() => ForecastFlow} createGtgFlow - Factory function to create a createGtgFlow instance.
|
|
91
81
|
* @property {() => ObservationsFlow} createObservationsFlow - Factory function to create an ObservationsFlow instance.
|
|
92
82
|
* @property {() => OneLayerFlow} createOneLayerFlow - Factory function to create an OneLayerFlow instance.
|
|
93
83
|
* @property {() => ADSBFlow} createAdsbFlow - Factory function to create an ADSBFlow instance.
|
|
@@ -110,7 +100,7 @@ export type SkyPathSDKOptions = {
|
|
|
110
100
|
* @async
|
|
111
101
|
* @function createSkyPathSDK
|
|
112
102
|
* @param {SkyPathSDKOptions} options - The options to initialize the SDK.
|
|
113
|
-
* @returns {Promise<SkyPathSDK>} - An object containing factory functions to create ForecastFlow,
|
|
103
|
+
* @returns {Promise<SkyPathSDK>} - An object containing factory functions to create ForecastFlow, ObservationsFlow or other flows.
|
|
114
104
|
* @example
|
|
115
105
|
* ```js
|
|
116
106
|
* // Initialize the SkyPath SDK with the API key, user ID, and company name.
|