@ksp-gonogo/sitrep-sdk 0.0.1

package/dist/__generated__/contract.d.ts

@@ -0,0 +1,936 @@
+export interface ActivateStrategyArgs {
+    strategyId: string;
+    factor: number;
+}
+export interface DeactivateStrategyArgs {
+    strategyId: string;
+}
+export interface UnlockTechArgs {
+    techId: string;
+}
+export interface ContractActionArgs {
+    contractId: string;
+}
+export interface UpgradeFacilityArgs {
+    facilityId: string;
+}
+export declare enum GameMode {
+    Sandbox = 0,
+    Career = 1,
+    Science = 2,
+    Unknown = 3
+}
+export interface CareerMode {
+    mode: GameMode;
+}
+export interface CareerStatus {
+    economy?: CareerEconomy;
+    facilities?: {
+        [key: string]: CareerFacility;
+    };
+    contracts?: CareerContracts;
+    strategies?: CareerStrategies;
+    tech?: CareerTech;
+}
+export interface CareerEconomy {
+    funds?: number;
+    reputation?: number;
+    science?: number;
+}
+export interface CareerFacility {
+    currentTier?: number;
+    maxTier?: number;
+    upgradeCost?: number;
+}
+export interface CareerContracts {
+    active: CareerContract[];
+    offered: CareerContract[];
+    completedRecent: CareerContract[];
+}
+export interface CareerContract {
+    id?: string;
+    title?: string;
+    agent?: string;
+    state?: string;
+    fundsAdvance?: number;
+    fundsCompletion?: number;
+    fundsFailure?: number;
+    scienceCompletion?: number;
+    reputationCompletion?: number;
+    reputationFailure?: number;
+    dateAccepted?: number;
+    dateDeadline?: number;
+    dateExpire?: number;
+    parameters: CareerContractParameter[];
+}
+export interface CareerContractParameter {
+    title?: string;
+    state?: string;
+}
+export interface CareerStrategies {
+    active: CareerStrategy[];
+    all: CareerStrategy[];
+    activeCount: number;
+}
+export interface CareerStrategy {
+    id?: string;
+    title?: string;
+    description?: string;
+    department?: string;
+    isActive?: boolean;
+    factor?: number;
+    dateActivated?: number;
+    requiredReputation?: number;
+    initialCostFunds?: number;
+    initialCostScience?: number;
+    initialCostReputation?: number;
+    hasFactorSlider?: boolean;
+    factorSliderDefault?: number;
+    factorSliderSteps?: number;
+    canActivate?: boolean;
+    activateBlockedReason?: string;
+    canDeactivate?: boolean;
+    deactivateBlockedReason?: string;
+    effect?: string;
+}
+export interface CareerTech {
+    unlockedCount: number;
+    unlockedIds: string[];
+    nodes: CareerTechNode[];
+}
+export interface CareerTechNode {
+    id?: string;
+    title?: string;
+    scienceCost?: number;
+    unlocked?: boolean;
+    parents: string[];
+}
+export declare enum CommandErrorCode {
+    None = 0,
+    Unknown = 1,
+    NoVessel = 2,
+    ModeUnavailable = 3,
+    Range = 4,
+    NotFound = 5,
+    Timeout = 6
+}
+export interface CommandResult {
+    success: boolean;
+    errorCode: CommandErrorCode;
+}
+export interface CommandResultOf<T> extends CommandResult {
+    payload?: T;
+}
+export declare enum CommsControlSource {
+    None = 0,
+    Partial = 1,
+    Full = 2
+}
+export interface CommsConnectivity {
+    connected: boolean;
+    controlSource: CommsControlSource;
+    hasLocalControl: boolean;
+    meta: PayloadMeta;
+}
+export interface CommsSignalStrength {
+    value: number;
+    meta: PayloadMeta;
+}
+export declare enum CommsControlStateKind {
+    None = 0,
+    PartialManoeuvre = 1,
+    Full = 2
+}
+export interface CommsControlState {
+    state: CommsControlStateKind;
+    reason?: string;
+    meta: PayloadMeta;
+}
+export declare enum CommsHopKind {
+    Home = 0,
+    Relay = 1,
+    Vessel = 2
+}
+export interface CommsHop {
+    from: string;
+    to: string;
+    kind: CommsHopKind;
+    distanceMeters?: number;
+    bandRateBitsPerSec?: number;
+}
+export interface CommsPath {
+    hops: CommsHop[];
+    meta: PayloadMeta;
+}
+export interface CommsNetworkNode {
+    id: string;
+    kind: CommsHopKind;
+}
+export interface CommsNetworkEdge {
+    a: string;
+    b: string;
+    active: boolean;
+}
+export interface CommsNetwork {
+    nodes: CommsNetworkNode[];
+    edges: CommsNetworkEdge[];
+    meta: PayloadMeta;
+}
+export declare enum CommsDelaySource {
+    None = 0,
+    SignalDelay = 1
+}
+export interface CommsDelay {
+    oneWaySeconds: number;
+    source: CommsDelaySource;
+    meta: PayloadMeta;
+}
+export interface CommsLinkQuality {
+    value: number;
+    meta: PayloadMeta;
+}
+export interface CommsDataRate {
+    upBitsPerSec: number;
+    downBitsPerSec: number;
+    meta: PayloadMeta;
+}
+export interface CommsLinkMargin {
+    decibelMargin: number;
+    closesLink: boolean;
+    meta: PayloadMeta;
+}
+export interface CrashReport {
+    vesselId: string;
+    eventKind: string;
+    what: string;
+    vesselType: string;
+    msg: string;
+    latitude: number;
+    longitude: number;
+    partsLost: CrashPartLost[];
+    body: string;
+    flightStats: CrashFlightStats;
+    vesselName: string;
+    events: string[];
+    kerbalsKilled: string[];
+    situation: string;
+    crewAboard: string[];
+    altitude: number;
+    ut: number;
+}
+export interface CrashPartLost {
+    partId: number;
+    partName: string;
+    partTitle: string;
+    msg: string;
+}
+export interface CrashFlightStats {
+    kerbalsKilled: number;
+    partsLost: number;
+    flightEndMode: string;
+    highestSpeedOverLand: number;
+    missionEnd: boolean;
+    highestGee: number;
+    highestAltitude: number;
+    totalDistance: number;
+    missionTime: number;
+    highestSpeed: number;
+    groundDistance: number;
+    liftOff: boolean;
+}
+export interface StreamData<T> {
+    type: "stream-data";
+    topic: string;
+    payload: T;
+    meta: Meta;
+}
+export interface EventMsg {
+    type: "event";
+    topic: string;
+    name: string;
+    meta: Meta;
+}
+export interface CommandRequest<TArgs> {
+    type: "command-request";
+    requestId: string;
+    command: string;
+    args: TArgs;
+    sentAt: number;
+}
+export interface CommandResponse<TResult> {
+    type: "command-response";
+    requestId: string;
+    result: TResult;
+    meta: Meta;
+}
+export interface ErrorMsg {
+    type: "error";
+    requestId?: string;
+    topic?: string;
+    code: string;
+    message: string;
+}
+export interface Subscribe {
+    type: "subscribe";
+    topic: string;
+}
+export interface Unsubscribe {
+    type: "unsubscribe";
+    topic: string;
+}
+export interface RevertToEditorArgs {
+    editor: string;
+}
+export interface SwitchVesselArgs {
+    vesselId: string;
+}
+export interface LaunchArgs {
+    shipName: string;
+    facility: string;
+    site: string;
+    crew: string[];
+}
+export interface SetFlyByWireArgs {
+    enabled: boolean;
+}
+export interface SetControlAxesArgs {
+    pitch?: number;
+    yaw?: number;
+    roll?: number;
+    x?: number;
+    y?: number;
+    z?: number;
+    pitchTrim?: number;
+    yawTrim?: number;
+    rollTrim?: number;
+}
+export interface GameDlc {
+    breakingGround: boolean;
+    makingHistory: boolean;
+}
+export interface KosProcessorInfo {
+    coreId: number;
+    tag?: string;
+    hasBooted: boolean;
+    bootFilePath?: string;
+    processorMode: string;
+}
+export interface KosComputeStatus {
+    running: boolean;
+    lastGoodAt?: number;
+    scriptError?: string;
+    parseError?: string;
+    paused: boolean;
+}
+export interface KosExecArgs {
+    coreId: number;
+    scriptId: string;
+}
+export interface KosReEnableArgs {
+    scriptId: string;
+}
+export declare enum Quality {
+    OnRails = 0,
+    Loaded = 1
+}
+export declare enum Staleness {
+    Fresh = 0,
+    HeldStale = 1,
+    LastBeforeBlackout = 2
+}
+export interface Meta {
+    source: string;
+    validAt: number;
+    seq: number;
+    deliveredAt: number;
+    vantage: string;
+    quality: Quality;
+    active: boolean;
+    staleness: Staleness;
+    timelineEpoch: number;
+    confidence?: number;
+}
+export interface PayloadMeta {
+    source: string;
+    quality: Quality;
+}
+export interface SolarPanelEntry {
+    partName?: string;
+    partId?: string;
+    deployState?: string;
+    flowRate?: number;
+    chargeRate?: number;
+    sunAOA?: number;
+}
+export interface BatteryEntry {
+    partName?: string;
+    partId?: string;
+    current?: number;
+    max?: number;
+}
+export interface FuelCellEntry {
+    partName?: string;
+    partId?: string;
+    active?: boolean;
+    status?: string;
+}
+export interface AlternatorEntry {
+    partName?: string;
+    partId?: string;
+    outputRate?: number;
+}
+export interface PartsPower {
+    solarPanels?: SolarPanelEntry[];
+    batteries?: BatteryEntry[];
+    fuelCells?: FuelCellEntry[];
+    alternators?: AlternatorEntry[];
+    totalProductionEc?: number;
+}
+export interface ServoEntry {
+    partName?: string;
+    partId?: string;
+    type?: string;
+    servoIsLocked?: boolean;
+    servoIsMotorized?: boolean;
+    servoMotorIsEngaged?: boolean;
+    servoMotorLimit?: number;
+    motorState?: string;
+    currentAngle?: number;
+    targetAngle?: number;
+    traverseVelocity?: number;
+    currentRPM?: number;
+    rpmLimit?: number;
+    normalizedOutput?: number;
+    brakePercentage?: number;
+    currentExtension?: number;
+    targetExtension?: number;
+    counterClockwise?: boolean;
+    maxTorque?: number;
+}
+export interface RoboticsAvailability {
+    available?: boolean;
+}
+export interface RevertAvailability {
+    canRevertToEditor: boolean;
+    canRevertToLaunch: boolean;
+}
+export interface ServoSetTargetArgs {
+    partId: string;
+    value: number;
+}
+export interface ServoSetEnabledArgs {
+    partId: string;
+    enabled: boolean;
+}
+export interface RotorSetValueArgs {
+    partId: string;
+    value: number;
+}
+export interface RotorReverseArgs {
+    partId: string;
+}
+export interface ScanSensorEntry {
+    type?: number;
+    fov?: number;
+    minAlt?: number;
+    maxAlt?: number;
+    bestAlt?: number;
+    inRange?: boolean;
+    bestRange?: boolean;
+}
+export interface ScanTrackColor {
+    r?: number;
+    g?: number;
+    b?: number;
+    a?: number;
+}
+export interface ScanningVesselEntry {
+    vesselId?: string;
+    vesselName?: string;
+    body?: string;
+    subLatitude?: number;
+    subLongitude?: number;
+    altitude?: number;
+    sensors?: ScanSensorEntry[];
+    groundTrackWidthDeg?: number;
+    groundTrackLonHalfDeg?: number;
+    trackColor?: ScanTrackColor;
+}
+export interface ScanScienceEntry {
+    partId?: string;
+    partTitle?: string;
+    expId?: string;
+    title?: string;
+    deployed?: boolean;
+    hasData?: boolean;
+    rerunnable?: boolean;
+    inoperable?: boolean;
+}
+export interface ExperimentActionArgs {
+    partId: string;
+}
+export interface ExperimentEntry {
+    partName?: string;
+    location?: string;
+    experimentId?: string;
+    subjectId?: string;
+    title?: string;
+    dataAmount?: number;
+    scienceValueRatio?: number;
+    baseTransmitValue?: number;
+    transmitBonus?: number;
+    labValue?: number;
+    deployed?: boolean;
+    inoperable?: boolean;
+    situation?: string;
+}
+export interface InstrumentEntry {
+    partId?: string;
+    partName?: string;
+    experimentId?: string;
+    title?: string;
+    deployed?: boolean;
+    inoperable?: boolean;
+    rerunnable?: boolean;
+    resettable?: boolean;
+    dataIsCollectable?: boolean;
+}
+export interface LabEntry {
+    partName?: string;
+    dataStored?: number;
+    dataStorage?: number;
+    storedScience?: number;
+    processingData?: boolean;
+    statusText?: string;
+    scientistCount?: number;
+    scienceRate?: number;
+    isOperational?: boolean;
+}
+export interface DeployedEntry {
+    vesselName?: string;
+    partName?: string;
+    body?: string;
+    situation?: string;
+    biome?: string;
+    experimentId?: string;
+    scienceCompletedPercentage?: number;
+    scienceTransmittedPercentage?: number;
+    scienceValue?: number;
+    scienceLimit?: number;
+    powerState?: string;
+    connectionState?: string;
+    deployedOnGround?: boolean;
+}
+export interface SensorEntry {
+    partId?: string;
+    partName?: string;
+    type?: string;
+    readout?: string;
+    active?: boolean;
+}
+export interface LaunchSiteEntry {
+    name?: string;
+    displayName?: string;
+    editorFacility?: string;
+    bodyIndex?: number;
+    isStock?: boolean;
+    padOccupied?: boolean;
+    padVesselTitle?: string;
+}
+export interface SpaceCenterScene {
+    scene?: string;
+}
+export interface CrewRosterEntry {
+    name?: string;
+    trait?: string;
+    experienceLevel?: number;
+    available?: boolean;
+    unavailableReason?: string;
+}
+export interface SavedShipEntry {
+    name?: string;
+    partCount?: number;
+    totalMass?: number;
+    facility?: string;
+    requiresFunds?: number;
+    missingParts?: string[];
+}
+export interface SpaceCenterPartsAvailable {
+    count?: number;
+}
+export interface StageDeltaVEntry {
+    stage?: number;
+    dvVac?: number;
+    dvAsl?: number;
+    dvActual?: number;
+    burnTime?: number;
+    twrVac?: number;
+    twrAsl?: number;
+    twrActual?: number;
+    thrustVac?: number;
+    thrustAsl?: number;
+    thrustActual?: number;
+    startMass?: number;
+    endMass?: number;
+    dryMass?: number;
+    fuelMass?: number;
+}
+export interface StageDeltaVSummary {
+    stageCount?: number;
+    totalDvVac?: number;
+    totalDvAsl?: number;
+    totalDvActual?: number;
+    totalBurnTime?: number;
+}
+export interface SystemBodies {
+    bodies: BodyEntry[];
+}
+export interface BodyEntry {
+    name?: string;
+    index: number;
+    parentIndex?: number;
+    radius?: number;
+    orbit?: OrbitEntry;
+}
+export interface OrbitEntry {
+    sma?: number;
+    ecc?: number;
+    inc?: number;
+    lan?: number;
+    argPe?: number;
+    meanAnomalyAtEpoch?: number;
+    epoch?: number;
+}
+export interface SystemVessels {
+    vessels: VesselRosterEntry[];
+}
+export interface VesselRosterEntry {
+    vesselId: string;
+    name: string;
+    vesselType: VesselType;
+    situation: Situation;
+    bodyIndex?: number;
+}
+export interface Vec3 {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface VesselAttitude {
+    pitch: number;
+    heading: number;
+    roll: number;
+    meta: PayloadMeta;
+}
+export interface SetEnabledArgs {
+    enabled: boolean;
+}
+export interface SetSasModeArgs {
+    mode: SasMode;
+}
+export interface SetThrottleArgs {
+    value: number;
+}
+export interface SetActionGroupArgs {
+    group: number;
+    state: boolean;
+}
+export interface AddManeuverNodeArgs {
+    ut: number;
+    prograde: number;
+    normal: number;
+    radialOut: number;
+}
+export interface UpdateManeuverNodeArgs {
+    nodeId: string;
+    ut: number;
+    prograde: number;
+    normal: number;
+    radialOut: number;
+}
+export interface RemoveManeuverNodeArgs {
+    nodeId: string;
+}
+export interface SetTargetArgs {
+    kind: TargetKind;
+    vesselId?: string;
+    bodyIndex?: number;
+}
+export interface SetWarpIndexArgs {
+    index: number;
+}
+export interface SetPausedArgs {
+    paused: boolean;
+}
+export declare enum ControlState {
+    None = 0,
+    Probe = 1,
+    Kerbal = 2,
+    Partial = 3,
+    Full = 4,
+    ProbeNone = 5,
+    ProbePartial = 6,
+    ProbeFull = 7,
+    KerbalNone = 8,
+    KerbalPartial = 9,
+    KerbalFull = 10,
+    Unknown = 11
+}
+export interface VesselComms {
+    connected: boolean;
+    signalStrength: number;
+    controlState: ControlState;
+    meta: PayloadMeta;
+}
+export declare enum SasMode {
+    StabilityAssist = 0,
+    Prograde = 1,
+    Retrograde = 2,
+    Normal = 3,
+    Antinormal = 4,
+    RadialIn = 5,
+    RadialOut = 6,
+    Target = 7,
+    AntiTarget = 8,
+    Maneuver = 9,
+    Unknown = 10
+}
+export interface VesselControl {
+    sas?: boolean;
+    sasMode?: SasMode;
+    rcs?: boolean;
+    gear?: boolean;
+    brakes?: boolean;
+    lights?: boolean;
+    abort?: boolean;
+    precisionControl?: boolean;
+    throttle?: number;
+    actionGroups?: boolean[];
+    meta: PayloadMeta;
+}
+export interface CrewMember {
+    name?: string;
+    trait?: string;
+    experienceLevel?: number;
+    type?: string;
+    rosterStatus?: string;
+}
+export interface VesselCrew {
+    count: number;
+    capacity: number;
+    crew: CrewMember[];
+    meta: PayloadMeta;
+}
+export interface DockAlignment {
+    relativePosition: Vec3;
+    relativeVelocity: Vec3;
+    distance: number;
+    forwardDot?: number;
+    meta: PayloadMeta;
+}
+export declare enum Situation {
+    Landed = 0,
+    Splashed = 1,
+    PreLaunch = 2,
+    Orbiting = 3,
+    Escaping = 4,
+    Flying = 5,
+    SubOrbital = 6,
+    Docked = 7,
+    Unknown = 8
+}
+export declare enum VesselType {
+    Ship = 0,
+    Station = 1,
+    Lander = 2,
+    Probe = 3,
+    Rover = 4,
+    Base = 5,
+    Relay = 6,
+    EVA = 7,
+    Flag = 8,
+    Debris = 9,
+    SpaceObject = 10,
+    DeployedScienceController = 11,
+    DeployedSciencePart = 12,
+    DroppedPart = 13,
+    Unknown = 14
+}
+export declare enum TransitionType {
+    Initial = 0,
+    Final = 1,
+    Encounter = 2,
+    Escape = 3,
+    Maneuver = 4,
+    Collision = 5,
+    Unknown = 6
+}
+export interface VesselFlight {
+    latitude: number;
+    longitude: number;
+    altitudeAsl: number;
+    altitudeTerrain: number;
+    verticalSpeed: number;
+    surfaceSpeed: number;
+    orbitalSpeed: number;
+    gForce: number;
+    dynamicPressureKPa: number;
+    mach: number;
+    atmDensity: number;
+    externalTemperature: number;
+    atmosphericTemperature: number;
+    meta: PayloadMeta;
+}
+export interface VesselIdentity {
+    vesselId: string;
+    name: string;
+    vesselType: VesselType;
+    situation: Situation;
+    parentBodyIndex?: number;
+    launchUt?: number;
+    meta: PayloadMeta;
+}
+export interface ManeuverNode {
+    id: string;
+    ut: number;
+    dvRadial?: number;
+    dvNormal?: number;
+    dvPrograde?: number;
+    dvTotal?: number;
+}
+export interface VesselManeuver {
+    nodes: ManeuverNode[];
+    meta: PayloadMeta;
+}
+export interface VesselOrbit {
+    referenceBodyIndex: number;
+    sma: number;
+    ecc: number;
+    inc: number;
+    lan?: number;
+    argPe?: number;
+    meanAnomalyAtEpoch: number;
+    epoch: number;
+    mu: number;
+    encounter?: OrbitEncounter;
+    meta: PayloadMeta;
+}
+export interface OrbitEncounter {
+    transitionType: TransitionType;
+    transitionUt: number;
+    bodyIndex?: number;
+}
+export interface VesselOrbitTruth {
+    position: Vec3;
+    velocity: Vec3;
+    frameRotating: boolean;
+    meta: PayloadMeta;
+}
+export interface VesselParts {
+    parts: VesselPart[];
+    meta: PayloadMeta;
+}
+export interface VesselPart {
+    id: string;
+    parentId?: string;
+    name: string;
+    title: string;
+    position: Vec3;
+    up?: Vec3;
+    bounds: PartBounds;
+    dryMass: number;
+    inverseStage: number;
+    maxTemp: number;
+    skinMaxTemp?: number;
+    currentTemp?: number;
+    skinTemp?: number;
+    category: string;
+    modules: string[];
+    isRobotics: boolean;
+    isPowerRelated: boolean;
+    fuelLineTargetId?: string;
+}
+export interface PartBounds {
+    size: Vec3;
+    center?: Vec3;
+}
+export declare enum PhysicsMode {
+    OnRails = 0,
+    Packed = 1,
+    Unpacked = 2,
+    Unknown = 3
+}
+export interface VesselPhysicsMode {
+    mode: PhysicsMode;
+    meta: PayloadMeta;
+}
+export interface VesselPropulsion {
+    totalMass: number;
+    dryMass: number;
+    currentThrust: number;
+    availableThrust: number;
+    meta: PayloadMeta;
+}
+export interface ResourceAmount {
+    current: number;
+    max: number;
+    active: boolean;
+}
+export interface VesselResources {
+    resources: {
+        [key: string]: ResourceAmount;
+    };
+    meta: PayloadMeta;
+}
+export interface VesselStructure {
+    currentStage: number;
+    stageCount?: number;
+    partCount?: number;
+    meta: PayloadMeta;
+}
+export interface VesselSurface {
+    biome?: string;
+    landedAt?: string;
+    heightFromTerrain?: number;
+    meta: PayloadMeta;
+}
+export declare enum TargetKind {
+    Vessel = 0,
+    Body = 1,
+    Other = 2
+}
+export interface VesselTarget {
+    name: string;
+    kind: TargetKind;
+    vesselId?: string;
+    bodyIndex?: number;
+    relativePosition?: Vec3;
+    relativeVelocity?: Vec3;
+    orbit?: VesselOrbit;
+    meta: PayloadMeta;
+}
+export interface ThermalHottestPart {
+    internalTemp: number;
+    maxTemp: number;
+    skinTemp: number;
+    skinMaxTemp: number;
+}
+export interface VesselThermal {
+    maxSkinTempRatio?: number;
+    maxInternalTempRatio?: number;
+    hottestPart?: ThermalHottestPart;
+    meta: PayloadMeta;
+}
+export declare enum WarpMode {
+    High = 0,
+    Low = 1,
+    Unknown = 2
+}
+export interface WarpState {
+    warpRate: number;
+    warpRateIndex: number;
+    warpMode: WarpMode;
+    paused: boolean;
+    meta: PayloadMeta;
+}
+//# sourceMappingURL=contract.d.ts.map