@qandq/cloud-gcs-core 1.2.45 → 1.2.47-C698

package/src/plugin-contract/models/PluginEventCallback.ts

@@ -1,5 +1,5 @@
 export interface PluginEventCallback{
     pluginName: string;
     eventName: string;
-    callback: (...args: any[]) => void;
+    callback(...args: any[]): void;
 }

package/src/plugin-contract/system-api/IFlightEventApi.ts

@@ -0,0 +1,5 @@
+import {FlightEventMessage} from "../../models/FlightEventMessage";
+
+export interface IFlightEventApi {
+    sendFlightEvent(log: FlightEventMessage): void;
+}

package/src/plugin-contract/system-api/IMissionApi.ts

@@ -2,6 +2,13 @@ import {AircraftMission} from "../../models/AircraftMission";
 import {AircraftIdentifier} from "../../models/AircraftIdentifier";
 
 export interface IMissionApi {
+    /**
+     * Retrieves the mission of the specified aircraft.
+     */
     getMission(identifier: AircraftIdentifier): AircraftMission | undefined;
+
+    /**
+     * Uploads a mission to the specified aircraft.
+     */
     uploadMission(identifier: AircraftIdentifier, data: AircraftMission): void;
-}
+}

package/src/plugin-contract/system-api/ISystemApi.ts

@@ -5,7 +5,7 @@ import { IUnitsApi } from "./units-api/IUnitsApi";
 import { IAircraftApi } from "./aircraft-api/IAircraftApi";
 import { IUserApi } from "./user-api/IUserApi";
 import {IHandOverApi} from "./handover-api/IHandOverApi";
-import {IMessageLoggerApi} from "./IMessageLogger";
+import {IFlightEventApi} from "./IFlightEventApi";
 import {IMissionApi} from "./IMissionApi";
 
 export interface ISystemApi {
@@ -18,5 +18,5 @@ export interface ISystemApi {
   userApi: IUserApi;
   handoverApi: IHandOverApi;
   getOrganizationName: () => string;
-  messageLoggerApi: IMessageLoggerApi;
+  flightEventApi: IFlightEventApi;
 }

package/src/plugin-contract/system-api/aircraft-api/IAircraftApi.ts

@@ -3,27 +3,78 @@ import { AircraftIdentifier } from "../../../models/AircraftIdentifier";
 import {LinkHealthStatus} from "../../../models/LinkHealthStatus";
 import {AircraftConfiguration} from "../../../models/AircraftConfiguration";
 import {CommandTypeEnum} from "../../../models/enums/CommandTypeEnum";
-import { LogLevel } from "../../../models/enums/LogLevel";
 import { AircraftPlugin } from "../../../models/AircraftPlugin";
 import {PluginCommandResponseData} from "../../../models/PluginCommandResponseData";
 import {PluginData} from "../../../models/PluginData";
 
 export interface IAircraftApi {
-  isBeingControlled: (identifier: AircraftIdentifier) => boolean;
-  isBeingObserved: (identifier: AircraftIdentifier) => boolean;
-  getObservingAircraft: () => AircraftIdentifier[];
-  getControllingAircraft: () => AircraftIdentifier[];
-  getAircraft3dModel: (aircraftId: number) => string;
-  setPilotageStatuses: (AircraftPilotageStatuses: AircraftPilotageStatus[]) => void
-  subscribeToAircraftStatuses: (initiate: boolean) => void;
-  changeActiveAircraft: (aircraftId: number) => void;
-  postAirText: (identifier: AircraftIdentifier, data: any) => void;
-  sendPluginCommandWithResponse(identifier: AircraftIdentifier, input: PluginData): Promise<PluginCommandResponseData | null>
-  sendPluginCommand: (identifier: AircraftIdentifier, command: string, data: any) => void;
+  /**
+   * Indicates whether the aircraft is being controlled.
+   */
+  isBeingControlled(identifier: AircraftIdentifier): boolean;
+
+  /**
+   * Indicates whether the aircraft is being observed.
+   */
+  isBeingObserved(identifier: AircraftIdentifier): boolean;
+
+  /**
+   * Returns the list of observed aircraft.
+   */
+  getObservingAircraft(): AircraftIdentifier[];
+
+  /**
+   * Returns the list of controlled aircraft.
+   */
+  getControllingAircraft(): AircraftIdentifier[];
+
+  /**
+   * Returns the 3D model file URL of the aircraft.
+   */
+  getAircraft3dModel(aircraftId: number): string;
+
+  /**
+   * Allows to set pilotage statuses for aircraft, including controlling, observing, or releasing them.
+   */
+  setPilotageStatuses(AircraftPilotageStatuses: AircraftPilotageStatus[]): void;
+
+  /**
+   * Changes the active selected aircraft.
+   */
+  changeActiveAircraft(aircraftId: number): void;
+
+  /**
+   * Sends data to the mission controller via Airtext channel.
+   */
+  postAirText(identifier: AircraftIdentifier, data: any): void;
+
+  /**
+   * Sends a command to a loaded plugin in the mission controller and returns the response for the command.
+   */
+  sendPluginCommandWithResponse(identifier: AircraftIdentifier, input: PluginData): Promise<PluginCommandResponseData | null>;
+
+  /**
+   * Executes a command on the aircraft, sending the required parameters in the data object based on the command type.
+   */
   executeCommand(identifier: AircraftIdentifier, command: CommandTypeEnum, data: any): void;
+
+  /**
+   * Returns the aircraft link health status information.
+   */
   getAircraftLinkHealthStatus(aircraftIdentifier: AircraftIdentifier): LinkHealthStatus | undefined;
+
+  /**
+   * Returns the aircraft configuration information.
+   */
   getAircraftConfiguration(identifier: AircraftIdentifier): AircraftConfiguration | null;
-  sendAircraftFlightLog(aircraftIdentifier: AircraftIdentifier, data: object, level: LogLevel, message: string, details: string): void;
-  isSimulator: (aircraftIdentifier: AircraftIdentifier) => boolean;
+
+  /**
+   * Returns true if the aircraft is a simulator.
+   */
+  isSimulator(aircraftIdentifier: AircraftIdentifier): boolean;
+
+  /**
+   * Lists the installed plugins in the mission controller.
+   */
   getAircraftPlugins(aircraftIdentifier: AircraftIdentifier): AircraftPlugin[];
 }

package/src/plugin-contract/system-api/aircraft-location-api/IAircraftLocationApi.ts

@@ -1,5 +1,9 @@
 import {AircraftLocation} from "../../../models/AircraftLocation";
 
 export interface IAircraftLocationApi {
-    getAircraftLocation: (aircraftId: number) => AircraftLocation | null;
+    /**
+     * Provides the current location information of the aircraft.
+     */
+    getAircraftLocation(aircraftId: number): AircraftLocation | null;
 }
+

package/src/plugin-contract/system-api/data-analyze-api/IDataAnalyzeApi.ts

@@ -1,5 +1,8 @@
 import { IPluginDataAnalysis } from '../../../models/data-analysis/IPluginDataAnalysis';
 
 export interface IDataAnalyzeApi {
-  getMessage: (aircraftId: number) => IPluginDataAnalysis | null;
+  /**
+   *
+   */
+  getMessage(aircraftId: number): IPluginDataAnalysis | null;
 }

package/src/plugin-contract/system-api/handover-api/IHandOverApi.ts

@@ -1,8 +1,25 @@
 import {HandOverResponseData} from "../../../models/handover/HandOverResponseData";
 
 export interface IHandOverApi {
-    handOver: (aircraftId: number, toUserCode: string) => void;
-    sendHandOverResponse: (answer: boolean, handOverCommand: HandOverResponseData) => void;
-    requestHandOver: (aircraftId: number | undefined) => void;
-    sendPilotMessage: (toUserCode: string, data: any) => void;
+    /**
+     * Sends a request for the specified pilot to take control over the actively controlled aircraft.
+     * Initiates a request to take control if the selected aircraft is currently controlled by the specified pilot.
+     */
+    handOver(aircraftId: number, toUserCode: string): void;
+
+    /**
+     * Used to respond to an incoming handover request.
+     */
+    sendHandOverResponse(answer: boolean, handOverCommand: HandOverResponseData): void;
+
+    /**
+     * Sends a request to the pilot currently controlling the specified aircraft to hand over control to you.
+     */
+    requestHandOver(aircraftId: number | undefined): void;
+
+    /**
+     * Sends a message to the specified user.
+     */
+    sendPilotMessage(toUserCode: string, data: any): void;
 }
+

package/src/plugin-contract/system-api/selected-aircraft-api/ISelectedAircraftApi.ts

@@ -4,20 +4,67 @@ import {AircraftLocation} from "../../../models/AircraftLocation";
 import {AircraftIdentifier} from "../../../models/AircraftIdentifier";
 import {CommandTypeEnum} from "../../../models/enums/CommandTypeEnum";
 import {PluginData} from "../../../models/PluginData";
-import { LogLevel } from "../../../models/enums/LogLevel";
 
 export interface ISelectedAircraftApi {
-    isBeingControlled: () => boolean | null;
-    getAircraftIdentifier: () => AircraftIdentifier | null;
-    getAircraftType: () => string | null;
-    getAircraft3dModel: () => string;
-    getAircraftConfiguration: () => AircraftConfiguration | null;
-    getTelemetry: () => AircraftTelemetry | null;
-    getLocation: () => AircraftLocation | null;
-    postAirText: (data: any) => void;
-    sendPluginCommand: (data: PluginData) => void;
+    /**
+     * Indicates whether the selected aircraft is being controlled.
+     */
+    isBeingControlled(): boolean | null;
+
+    /**
+     * Returns the identifier of the selected aircraft.
+     */
+    getAircraftIdentifier(): AircraftIdentifier | null;
+
+    /**
+     * Returns the type of the selected aircraft.
+     */
+    getAircraftType(): string | null;
+
+    /**
+     * Returns the 3D model address of the selected aircraft.
+     */
+    getAircraft3dModel(): string;
+
+    /**
+     * Returns the configuration settings of the selected aircraft.
+     */
+    getAircraftConfiguration(): AircraftConfiguration | null;
+
+    /**
+     * Returns the latest telemetry data of the selected aircraft.
+     */
+    getTelemetry(): AircraftTelemetry | null;
+
+    /**
+     * Returns the location information of the selected aircraft.
+     */
+    getLocation(): AircraftLocation | null;
+
+    /**
+     * Sends data to the selected aircraft via Airtext channel.
+     */
+    postAirText(data: any): void;
+
+    /**
+     * Sends a command to a plugin installed on the selected aircraft.
+     */
+    sendPluginCommand(data: PluginData): void;
+
+    /**
+     * Sends a command to the selected aircraft.
+     */
     executeCommand(command: CommandTypeEnum, data: any): void;
-    isPluginSupported: () => boolean;
-    getPluginConfig: () => any;
-    sendAircraftFlightLog(data: object, level: LogLevel, message: string, details:string): void;
+
+    /**
+     * Indicates whether this plugin is supported on the selected aircraft.
+     * Returns false if the plugin is not installed on the aircraft.
+     */
+    isPluginSupported(): boolean;
+
+    /**
+     * Returns the configuration of this plugin on the selected aircraft.
+     */
+    getPluginConfig(): any;
 }
+

package/src/plugin-contract/system-api/telemetry-api/ITelemetryApi.ts

@@ -1,5 +1,9 @@
 import {AircraftTelemetry} from "../../../models/telemetry/AircraftTelemetry";
 
 export interface ITelemetryApi {
-    getTelemetry: (aircraftId: number) => AircraftTelemetry | null;
+    /**
+     * Retrieves the latest telemetry data of the specified aircraft.
+     */
+    getTelemetry(aircraftId: number): AircraftTelemetry | null;
 }
+

package/src/plugin-contract/system-api/units-api/IUnitsApi.ts

@@ -2,9 +2,28 @@ import {UnitSystemEnum} from "../../../models/enums/UnitSystemEnum";
 import {UnitTypeEnum} from "../../../models/enums/UnitTypeEnum";
 
 export interface IUnitsApi {
-    convertToString: (system: UnitSystemEnum, type: UnitTypeEnum, value: number) => string;
-    convertNumber: (system: UnitSystemEnum, type: UnitTypeEnum, value: number) => number;
-    convertToSI: (system: UnitSystemEnum, unit: UnitTypeEnum, value: number) => number;
-    getUnitText: (system: UnitSystemEnum, type: UnitTypeEnum) => string;
-    getUnitSystem: () => UnitSystemEnum;
+    /**
+     *
+     */
+    convertToString(system: UnitSystemEnum, type: UnitTypeEnum, value: number): string;
+
+    /**
+     *
+     */
+    convertNumber(system: UnitSystemEnum, type: UnitTypeEnum, value: number): number;
+
+    /**
+     *
+     */
+    convertToSI(system: UnitSystemEnum, unit: UnitTypeEnum, value: number): number;
+
+    /**
+     *
+     */
+    getUnitText(system: UnitSystemEnum, type: UnitTypeEnum): string;
+
+    /**
+     *
+     */
+    getUnitSystem(): UnitSystemEnum;
 }

package/src/plugin-contract/system-api/user-api/IUserApi.ts

@@ -2,6 +2,14 @@ import { User } from "../../../models/user/User";
 import {UserStatus} from "../../../models/UserStatus";
 
 export interface IUserApi {
-  getUserInfo: () => User;
+  /**
+   * Returns information about the current user.
+   */
+  getUserInfo(): User;
+
+  /**
+   * Lists active users in the system.
+   */
   getActiveUsers(): UserStatus[];
 }
+

package/dist/models/FlightLogType.d.ts

@@ -1,6 +0,0 @@
-export declare enum FlightLogType {
-    StartFlightSession = 0,
-    EndFlightSession = 1,
-    Others = 2,
-    GpsLoss = 3
-}

package/dist/models/MessageLog.d.ts

@@ -1,11 +0,0 @@
-import { LogLevel } from "../index";
-export declare class MessageLog {
-    source: string;
-    time: string;
-    message: string;
-    level: LogLevel;
-    data: object;
-    timestamp: number;
-    details: string;
-    constructor(message: string, logLevel: LogLevel, details: string, data?: object, source?: string);
-}

package/dist/models/PluginLogMessage.d.ts

@@ -1,11 +0,0 @@
-import { LogLevel } from "./enums/LogLevel";
-import { AircraftIdentifier } from "./AircraftIdentifier";
-export interface PluginLogMessage {
-    msg: string;
-    details?: string;
-    logLevel: LogLevel;
-    data: any | null;
-}
-export interface PluginAircraftLogMessage extends PluginLogMessage {
-    aircraftIdentifier: AircraftIdentifier;
-}

package/dist/plugin-contract/system-api/IMessageLogger.d.ts

@@ -1,6 +0,0 @@
-import { PluginAircraftLogMessage, PluginLogMessage } from "../../models/PluginLogMessage";
-export interface IMessageLoggerApi {
-    publishPilotLogMessage: (log: PluginAircraftLogMessage, isSendOtherPlugins: boolean) => void;
-    publishLogMessage: (log: PluginLogMessage) => void;
-    publishAircraftLogMessage: (log: PluginAircraftLogMessage) => void;
-}

package/src/models/FlightLogType.ts

@@ -1,6 +0,0 @@
-export enum FlightLogType {
-    StartFlightSession,
-    EndFlightSession,
-    Others,
-    GpsLoss,
-}

package/src/models/MessageLog.ts

@@ -1,23 +0,0 @@
-import {LogLevel} from "../index";
-
-export class MessageLog {
-    source: string;
-    time: string;
-    message: string;
-    level: LogLevel;
-    data: object;
-    timestamp: number;
-    details: string;
-
-
-    public constructor(message: string, logLevel: LogLevel, details: string, data?: object,source?: string, ) {
-        this.timestamp = new Date().getTime()
-        this.time = new Date().toLocaleTimeString('en-US', { hour: '2-digit', minute: '2-digit', second: '2-digit' });
-        this.source = source ?? "System";
-        this.message = message;
-        this.level = logLevel;
-        this.data = data ? data : {};
-        this.details = details;
-    }
-}
-

package/src/models/PluginLogMessage.ts

@@ -1,13 +0,0 @@
-import {LogLevel} from "./enums/LogLevel";
-import {AircraftIdentifier} from "./AircraftIdentifier";
-
-export interface PluginLogMessage {
-    msg: string;
-    details?: string;
-    logLevel: LogLevel;
-    data: any | null
-}
-
-export interface PluginAircraftLogMessage extends PluginLogMessage{
-    aircraftIdentifier: AircraftIdentifier
-}

package/src/plugin-contract/system-api/IMessageLogger.ts

@@ -1,7 +0,0 @@
-import {PluginAircraftLogMessage, PluginLogMessage} from "../../models/PluginLogMessage";
-
-export interface IMessageLoggerApi {
-    publishPilotLogMessage: (log: PluginAircraftLogMessage, isSendOtherPlugins: boolean) => void;
-    publishLogMessage: (log: PluginLogMessage) => void;
-    publishAircraftLogMessage: (log: PluginAircraftLogMessage) => void;
-}