@qandq/cloud-gcs-core 1.2.65 → 1.2.66
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/dist/index.d.ts +2 -1
- package/dist/plugin-contract/system-api/ISystemApi.d.ts +2 -0
- package/dist/plugin-contract/system-api/service-topic-api/IServiceTopicApi.d.ts +25 -0
- package/package.json +1 -1
- package/src/index.ts +2 -0
- package/src/plugin-contract/system-api/ISystemApi.ts +2 -0
- package/src/plugin-contract/system-api/service-topic-api/IServiceTopicApi.ts +28 -0
package/dist/index.d.ts
CHANGED
|
@@ -91,6 +91,7 @@ import { UIPluginCommand } from "./models/UIPluginCommand";
|
|
|
91
91
|
import { IFlightEventApi } from "./plugin-contract/system-api/IFlightEventApi";
|
|
92
92
|
import { IInboundStreamerApi } from "./plugin-contract/system-api/inbound-streamer-api/IInboundStreamerApi";
|
|
93
93
|
import { InboundStreamerDevice } from "./models/InboundStreamerDevice";
|
|
94
|
+
import { IServiceTopicApi } from "./plugin-contract/system-api/service-topic-api/IServiceTopicApi";
|
|
94
95
|
import { IMissionApi } from "./plugin-contract/system-api/IMissionApi";
|
|
95
96
|
import { IUserAuth } from "./models/user/IUser";
|
|
96
97
|
import { Mission } from "./models/Mission";
|
|
@@ -100,5 +101,5 @@ import { FlightEventMessage } from "./models/FlightEventMessage";
|
|
|
100
101
|
import { FlightEventMessageInput } from "./models/FlightEventMessageInput";
|
|
101
102
|
import { FlightEventTarget } from "./models/FlightEventTarget";
|
|
102
103
|
import { GuidanceType } from "./models/enums/GuidanceType";
|
|
103
|
-
export type { IPlugin, IPluginApi, IPluginEventManager, IPluginServiceManager, IPluginUIManager, IEventListener, ISystemApi, IAircraftLocationApi, ISelectedAircraftApi, ITelemetryApi, IDataAnalyzeApi, IUnitsApi, IUserApi, IHandOverApi, IAircraftApi, AircraftInfo, AircraftLocation, AircraftTelemetry, AircraftWarningStatuses, AirInfo, AttitudeInfo, BatteryInfo, ClimbInfo, CommandInfo, Coordinates2D, EngineInfo, HeadingInfo, IndexedWaypoint, PluginService, MenuItem, PluginEventArgs, PluginEventCallback, PluginServiceInformation, SpeedInfo, StatusInfo, Waypoint, User, AircraftPlugin, AircraftPilotageStatus, AircraftState, AircraftStatusTopicMessage, PilotUserHealth, GCSController, UserStatusTopicSubscriptionMessage, HandOverResponseData, HandOverCommandData, AircraftIdentifier, GPSInfo, PluginTelemetryData, VtolControlInfo, VtolQuadInfo, LinkHealthStatus, AircraftMission, GeoFence, FailSafe, NavigationCommandParam, FailSafeAction, Coordinates, FlightIdentifier, PluginCallback, PluginCommandResponseData, UserStatus, ICurrentUser, UIPluginCommand, IFlightEventApi, IInboundStreamerApi, InboundStreamerDevice, IMissionApi, IUserAuth, Mission, PilotUserStatus, TelemetryHeader, FlightEventMessage, FlightEventMessageInput, PersistentKey, PersistentValue, PersistentResponse, };
|
|
104
|
+
export type { IPlugin, IPluginApi, IPluginEventManager, IPluginServiceManager, IPluginUIManager, IEventListener, ISystemApi, IAircraftLocationApi, ISelectedAircraftApi, ITelemetryApi, IDataAnalyzeApi, IUnitsApi, IUserApi, IHandOverApi, IAircraftApi, AircraftInfo, AircraftLocation, AircraftTelemetry, AircraftWarningStatuses, AirInfo, AttitudeInfo, BatteryInfo, ClimbInfo, CommandInfo, Coordinates2D, EngineInfo, HeadingInfo, IndexedWaypoint, PluginService, MenuItem, PluginEventArgs, PluginEventCallback, PluginServiceInformation, SpeedInfo, StatusInfo, Waypoint, User, AircraftPlugin, AircraftPilotageStatus, AircraftState, AircraftStatusTopicMessage, PilotUserHealth, GCSController, UserStatusTopicSubscriptionMessage, HandOverResponseData, HandOverCommandData, AircraftIdentifier, GPSInfo, PluginTelemetryData, VtolControlInfo, VtolQuadInfo, LinkHealthStatus, AircraftMission, GeoFence, FailSafe, NavigationCommandParam, FailSafeAction, Coordinates, FlightIdentifier, PluginCallback, PluginCommandResponseData, UserStatus, ICurrentUser, UIPluginCommand, IFlightEventApi, IInboundStreamerApi, InboundStreamerDevice, IServiceTopicApi, IMissionApi, IUserAuth, Mission, PilotUserStatus, TelemetryHeader, FlightEventMessage, FlightEventMessageInput, PersistentKey, PersistentValue, PersistentResponse, };
|
|
104
105
|
export { SensorStatus, CommandTypeEnum, CommandSourceEnum, GPSCorrectionStatusEnum, UnitTypeEnum, GPSFixStatusEnum, PayloadRetractStatusEnum, TravelStatusEnum, UnitSystemEnum, WarningStatusEnum, PilotageStateEnum, UserTypeEnum, AircraftHealthEnum, HandOverCommandType, IndicatorStatusEnum, LogLevel, FailSafeTypeEnum, PluginNames, PluginServiceNames, PilotageStatus, PluginData, ClientType, IPluginDataAnalysis, FlightEventTarget, GuidanceType };
|
|
@@ -8,6 +8,7 @@ import { IHandOverApi } from "./handover-api/IHandOverApi";
|
|
|
8
8
|
import { IFlightEventApi } from "./IFlightEventApi";
|
|
9
9
|
import { IMissionApi } from "./IMissionApi";
|
|
10
10
|
import { IInboundStreamerApi } from "./inbound-streamer-api/IInboundStreamerApi";
|
|
11
|
+
import { IServiceTopicApi } from "./provider-api/IProviderApi";
|
|
11
12
|
export interface ISystemApi {
|
|
12
13
|
aircraftLocationApi: IAircraftLocationApi;
|
|
13
14
|
selectedAircraftApi: ISelectedAircraftApi;
|
|
@@ -20,4 +21,5 @@ export interface ISystemApi {
|
|
|
20
21
|
getOrganizationName: () => string;
|
|
21
22
|
flightEventApi: IFlightEventApi;
|
|
22
23
|
inboundStreamerApi: IInboundStreamerApi;
|
|
24
|
+
serviceTopicApi: IServiceTopicApi;
|
|
23
25
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
export interface IServiceTopicApi {
|
|
2
|
+
/**
|
|
3
|
+
* Scans service topics for 5 seconds and returns all unique topic names discovered
|
|
4
|
+
* under the pattern `tenantCode/S/aircraftName/+/ST`.
|
|
5
|
+
* If called again while a scan is already in progress, returns the same in-flight promise
|
|
6
|
+
* without starting a new scan.
|
|
7
|
+
*/
|
|
8
|
+
getServiceTopics(aircraftName: string): Promise<string[]>;
|
|
9
|
+
/**
|
|
10
|
+
* Scans all service topics for 5 seconds and returns all unique topic names discovered
|
|
11
|
+
* under the pattern `tenantCode/S/+/+/ST`, regardless of aircraft.
|
|
12
|
+
* If called again while a scan is already in progress, returns the same in-flight promise
|
|
13
|
+
* without starting a new scan.
|
|
14
|
+
*/
|
|
15
|
+
getAllServiceTopics(): Promise<string[]>;
|
|
16
|
+
/**
|
|
17
|
+
* Subscribes to the given service topic and calls `callback` every time a new message arrives.
|
|
18
|
+
* Returns a subscription ID that can be passed to `unsubscribeServiceTopic` to stop listening.
|
|
19
|
+
*/
|
|
20
|
+
subscribeServiceTopic(topic: string, callback: (payload: any) => void): string;
|
|
21
|
+
/**
|
|
22
|
+
* Unsubscribes a previously created service topic subscription by its subscription ID.
|
|
23
|
+
*/
|
|
24
|
+
unsubscribeServiceTopic(subscriptionId: string): void;
|
|
25
|
+
}
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -97,6 +97,7 @@ import {UIPluginCommand} from "./models/UIPluginCommand";
|
|
|
97
97
|
import {IFlightEventApi} from "./plugin-contract/system-api/IFlightEventApi";
|
|
98
98
|
import {IInboundStreamerApi} from "./plugin-contract/system-api/inbound-streamer-api/IInboundStreamerApi";
|
|
99
99
|
import {InboundStreamerDevice} from "./models/InboundStreamerDevice";
|
|
100
|
+
import {IServiceTopicApi} from "./plugin-contract/system-api/service-topic-api/IServiceTopicApi";
|
|
100
101
|
import {IMissionApi} from "./plugin-contract/system-api/IMissionApi";
|
|
101
102
|
import {IUserAuth} from "./models/user/IUser";
|
|
102
103
|
import {Mission} from "./models/Mission";
|
|
@@ -175,6 +176,7 @@ export type {
|
|
|
175
176
|
IFlightEventApi,
|
|
176
177
|
IInboundStreamerApi,
|
|
177
178
|
InboundStreamerDevice,
|
|
179
|
+
IServiceTopicApi,
|
|
178
180
|
IMissionApi,
|
|
179
181
|
IUserAuth,
|
|
180
182
|
Mission,
|
|
@@ -8,6 +8,7 @@ import {IHandOverApi} from "./handover-api/IHandOverApi";
|
|
|
8
8
|
import {IFlightEventApi} from "./IFlightEventApi";
|
|
9
9
|
import {IMissionApi} from "./IMissionApi";
|
|
10
10
|
import {IInboundStreamerApi} from "./inbound-streamer-api/IInboundStreamerApi";
|
|
11
|
+
import {IServiceTopicApi} from "./provider-api/IProviderApi";
|
|
11
12
|
|
|
12
13
|
export interface ISystemApi {
|
|
13
14
|
aircraftLocationApi: IAircraftLocationApi;
|
|
@@ -21,4 +22,5 @@ export interface ISystemApi {
|
|
|
21
22
|
getOrganizationName: () => string;
|
|
22
23
|
flightEventApi: IFlightEventApi;
|
|
23
24
|
inboundStreamerApi: IInboundStreamerApi;
|
|
25
|
+
serviceTopicApi: IServiceTopicApi;
|
|
24
26
|
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export interface IServiceTopicApi {
|
|
2
|
+
/**
|
|
3
|
+
* Scans service topics for 5 seconds and returns all unique topic names discovered
|
|
4
|
+
* under the pattern `tenantCode/S/aircraftName/+/ST`.
|
|
5
|
+
* If called again while a scan is already in progress, returns the same in-flight promise
|
|
6
|
+
* without starting a new scan.
|
|
7
|
+
*/
|
|
8
|
+
getServiceTopics(aircraftName: string): Promise<string[]>;
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Scans all service topics for 5 seconds and returns all unique topic names discovered
|
|
12
|
+
* under the pattern `tenantCode/S/+/+/ST`, regardless of aircraft.
|
|
13
|
+
* If called again while a scan is already in progress, returns the same in-flight promise
|
|
14
|
+
* without starting a new scan.
|
|
15
|
+
*/
|
|
16
|
+
getAllServiceTopics(): Promise<string[]>;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Subscribes to the given service topic and calls `callback` every time a new message arrives.
|
|
20
|
+
* Returns a subscription ID that can be passed to `unsubscribeServiceTopic` to stop listening.
|
|
21
|
+
*/
|
|
22
|
+
subscribeServiceTopic(topic: string, callback: (payload: any) => void): string;
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Unsubscribes a previously created service topic subscription by its subscription ID.
|
|
26
|
+
*/
|
|
27
|
+
unsubscribeServiceTopic(subscriptionId: string): void;
|
|
28
|
+
}
|