tachyon-protocol 1.7.0 → 1.8.0

package/dist/types.d.ts

@@ -0,0 +1,603 @@
+type TachyonCommand = AutohostAddPlayerRequest | AutohostAddPlayerResponse | AutohostKickPlayerRequest | AutohostKickPlayerResponse | AutohostKillRequest | AutohostKillResponse | AutohostMutePlayerRequest | AutohostMutePlayerResponse | AutohostSendCommandRequest | AutohostSendCommandResponse | AutohostSendMessageRequest | AutohostSendMessageResponse | AutohostSpecPlayersRequest | AutohostSpecPlayersResponse | AutohostStartRequest | AutohostStartResponse | AutohostStatusEvent | AutohostSubscribeUpdatesRequest | AutohostSubscribeUpdatesResponse | AutohostUpdateEvent | BattleStartRequest | BattleStartResponse | MatchmakingCancelRequest | MatchmakingCancelResponse | MatchmakingFoundEvent | MatchmakingFoundUpdateEvent | MatchmakingListRequest | MatchmakingListResponse | MatchmakingLostEvent | MatchmakingQueueRequest | MatchmakingQueueResponse | MatchmakingQueueUpdateEvent | MatchmakingReadyRequest | MatchmakingReadyResponse | MatchmakingReadyUpdateEvent | SystemDisconnectRequest | SystemDisconnectResponse | SystemServerStatsRequest | SystemServerStatsResponse | UserUpdatedEvent;
+type UserId = string;
+type AutohostAddPlayerResponse = AutohostAddPlayerOkResponse | AutohostAddPlayerFailResponse;
+type AutohostKickPlayerResponse = AutohostKickPlayerOkResponse | AutohostKickPlayerFailResponse;
+type AutohostKillResponse = AutohostKillOkResponse | AutohostKillFailResponse;
+type AutohostMutePlayerResponse = AutohostMutePlayerOkResponse | AutohostMutePlayerFailResponse;
+type AutohostSendCommandResponse = AutohostSendCommandOkResponse | AutohostSendCommandFailResponse;
+type AutohostSendMessageResponse = AutohostSendMessageOkResponse | AutohostSendMessageFailResponse;
+type AutohostSpecPlayersResponse = AutohostSpecPlayersOkResponse | AutohostSpecPlayersFailResponse;
+type StartPosType = "fixed" | "random" | "ingame" | "beforegame";
+type AutohostStartResponse = AutohostStartOkResponse | AutohostStartFailResponse;
+type UnixTime = number;
+type AutohostSubscribeUpdatesResponse = AutohostSubscribeUpdatesOkResponse | AutohostSubscribeUpdatesFailResponse;
+type PlayerChatUpdate = {
+    type: "player_chat";
+    userId: UserId;
+    message: string;
+    destination: "allies" | "all" | "spectators";
+} | {
+    type: "player_chat";
+    userId: UserId;
+    message: string;
+    destination: "player";
+    toUserId: UserId;
+};
+type BattleStartResponse = BattleStartOkResponse | BattleStartFailResponse;
+type MatchmakingCancelResponse = MatchmakingCancelOkResponse | MatchmakingCancelFailResponse;
+type MatchmakingListResponse = MatchmakingListOkResponse | MatchmakingListFailResponse;
+type MatchmakingQueueResponse = MatchmakingQueueOkResponse | MatchmakingQueueFailResponse;
+type MatchmakingReadyResponse = MatchmakingReadyOkResponse | MatchmakingReadyFailResponse;
+type SystemDisconnectResponse = SystemDisconnectOkResponse | SystemDisconnectFailResponse;
+type SystemServerStatsResponse = SystemServerStatsOkResponse | SystemServerStatsFailResponse;
+interface AutohostAddPlayerRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/addPlayer";
+    data: AutohostAddPlayerRequestData;
+}
+interface AutohostAddPlayerRequestData {
+    battleId: string;
+    userId: UserId;
+    name: string;
+    password: string;
+}
+interface AutohostAddPlayerOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/addPlayer";
+    status: "success";
+}
+interface AutohostAddPlayerFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/addPlayer";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostKickPlayerRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/kickPlayer";
+    data: AutohostKickPlayerRequestData;
+}
+interface AutohostKickPlayerRequestData {
+    battleId: string;
+    userId: UserId;
+}
+interface AutohostKickPlayerOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/kickPlayer";
+    status: "success";
+}
+interface AutohostKickPlayerFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/kickPlayer";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostKillRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/kill";
+    data: AutohostKillRequestData;
+}
+interface AutohostKillRequestData {
+    battleId: string;
+}
+interface AutohostKillOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/kill";
+    status: "success";
+}
+interface AutohostKillFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/kill";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostMutePlayerRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/mutePlayer";
+    data: AutohostMutePlayerRequestData;
+}
+interface AutohostMutePlayerRequestData {
+    battleId: string;
+    userId: UserId;
+    chat: boolean;
+    draw: boolean;
+}
+interface AutohostMutePlayerOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/mutePlayer";
+    status: "success";
+}
+interface AutohostMutePlayerFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/mutePlayer";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostSendCommandRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/sendCommand";
+    data: AutohostSendCommandRequestData;
+}
+interface AutohostSendCommandRequestData {
+    battleId: string;
+    command: string;
+    arguments?: string[];
+}
+interface AutohostSendCommandOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/sendCommand";
+    status: "success";
+}
+interface AutohostSendCommandFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/sendCommand";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostSendMessageRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/sendMessage";
+    data: AutohostSendMessageRequestData;
+}
+interface AutohostSendMessageRequestData {
+    battleId: string;
+    message: string;
+}
+interface AutohostSendMessageOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/sendMessage";
+    status: "success";
+}
+interface AutohostSendMessageFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/sendMessage";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostSpecPlayersRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/specPlayers";
+    data: AutohostSpecPlayersRequestData;
+}
+interface AutohostSpecPlayersRequestData {
+    battleId: string;
+    userIds: UserId[];
+}
+interface AutohostSpecPlayersOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/specPlayers";
+    status: "success";
+}
+interface AutohostSpecPlayersFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/specPlayers";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostStartRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/start";
+    data: AutohostStartRequestData;
+}
+interface AutohostStartRequestData {
+    battleId: string;
+    engineVersion: string;
+    gameName: string;
+    mapName: string;
+    gameArchiveHash?: string;
+    mapArchiveHash?: string;
+    startDelay?: number;
+    startPosType: StartPosType;
+    allyTeams: [AllyTeam, ...AllyTeam[]];
+    spectators?: Player[];
+    mapOptions?: {
+        [k: string]: string;
+    };
+    gameOptions?: {
+        [k: string]: string;
+    };
+    restrictions?: {
+        [k: string]: number;
+    };
+    luamsgRegexp?: string;
+}
+interface AllyTeam {
+    teams: [Team, ...Team[]];
+    startBox?: StartBox;
+    allies?: number[];
+    customProperties?: CustomStartScriptProperties;
+}
+interface Team {
+    players?: Player[];
+    bots?: Bot[];
+    advantage?: number;
+    incomeMultiplier?: number;
+    faction?: string;
+    color?: {
+        r: number;
+        g: number;
+        b: number;
+    };
+    startPos?: {
+        x: number;
+        y: number;
+    };
+    customProperties?: CustomStartScriptProperties;
+}
+interface Player {
+    userId: UserId;
+    name: string;
+    password: string;
+    rank?: number;
+    countryCode?: string;
+    customProperties?: CustomStartScriptProperties;
+}
+interface CustomStartScriptProperties {
+    [k: string]: string;
+}
+interface Bot {
+    hostUserId: string;
+    name?: string;
+    aiShortName: string;
+    aiVersion?: string;
+    aiOptions?: {
+        [k: string]: string;
+    };
+    customProperties?: CustomStartScriptProperties;
+}
+interface StartBox {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+}
+interface AutohostStartOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/start";
+    status: "success";
+    data: AutohostStartOkResponseData;
+}
+interface AutohostStartOkResponseData {
+    ips: string[];
+    port: number;
+}
+interface AutohostStartFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/start";
+    status: "failed";
+    reason: "battle_already_exists" | "engine_version_not_available" | "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostStatusEvent {
+    type: "event";
+    messageId: string;
+    commandId: "autohost/status";
+    data: AutohostStatusEventData;
+}
+interface AutohostStatusEventData {
+    maxBattles: number;
+    currentBattles: number;
+}
+interface AutohostSubscribeUpdatesRequest {
+    type: "request";
+    messageId: string;
+    commandId: "autohost/subscribeUpdates";
+    data: AutohostSubscribeUpdatesRequestData;
+}
+interface AutohostSubscribeUpdatesRequestData {
+    since: UnixTime;
+}
+interface AutohostSubscribeUpdatesOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/subscribeUpdates";
+    status: "success";
+}
+interface AutohostSubscribeUpdatesFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "autohost/subscribeUpdates";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface AutohostUpdateEvent {
+    type: "event";
+    messageId: string;
+    commandId: "autohost/update";
+    data: AutohostUpdateEventData;
+}
+interface AutohostUpdateEventData {
+    battleId: string;
+    time: UnixTime;
+    update: StartUpdate | FinishedUpdate | EngineMessageUpdate | EngineWarningUpdate | EngineQuitUpdate | EngineCrashUpdate | PlayerJoinedUpdate | PlayerLeftUpdate | PlayerChatUpdate | PlayerDefeatedUpdate | LuaMsgUpdate;
+}
+interface StartUpdate {
+    type: "start";
+}
+interface FinishedUpdate {
+    type: "finished";
+    userId: UserId;
+    winningAllyTeams: [number, ...number[]];
+}
+interface EngineMessageUpdate {
+    type: "engine_message";
+    message: string;
+}
+interface EngineWarningUpdate {
+    type: "engine_warning";
+    message: string;
+}
+interface EngineQuitUpdate {
+    type: "engine_quit";
+}
+interface EngineCrashUpdate {
+    type: "engine_crash";
+    details?: string;
+}
+interface PlayerJoinedUpdate {
+    type: "player_joined";
+    userId: UserId;
+    playerNumber: number;
+}
+interface PlayerLeftUpdate {
+    type: "player_left";
+    userId: UserId;
+    reason: "lost_connection" | "left" | "kicked";
+}
+interface PlayerDefeatedUpdate {
+    type: "player_defeated";
+    userId: UserId;
+}
+interface LuaMsgUpdate {
+    type: "luamsg";
+    userId: UserId;
+    script: "ui" | "game" | "rules";
+    uiMode?: "all" | "allies" | "spectators";
+    data: string;
+}
+interface BattleStartRequest {
+    type: "request";
+    messageId: string;
+    commandId: "battle/start";
+    data: BattleStartRequestData;
+}
+interface BattleStartRequestData {
+    username: string;
+    password: string;
+    ip: string;
+    port: number;
+}
+interface BattleStartOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "battle/start";
+    status: "success";
+}
+interface BattleStartFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "battle/start";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface MatchmakingCancelRequest {
+    type: "request";
+    messageId: string;
+    commandId: "matchmaking/cancel";
+}
+interface MatchmakingCancelOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/cancel";
+    status: "success";
+}
+interface MatchmakingCancelFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/cancel";
+    status: "failed";
+    reason: "not_queued" | "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface MatchmakingFoundEvent {
+    type: "event";
+    messageId: string;
+    commandId: "matchmaking/found";
+    data: MatchmakingFoundEventData;
+}
+interface MatchmakingFoundEventData {
+    queueId: string;
+    timeoutMs: number;
+}
+interface MatchmakingFoundUpdateEvent {
+    type: "event";
+    messageId: string;
+    commandId: "matchmaking/foundUpdate";
+    data: MatchmakingFoundUpdateEventData;
+}
+interface MatchmakingFoundUpdateEventData {
+    readyCount: number;
+}
+interface MatchmakingListRequest {
+    type: "request";
+    messageId: string;
+    commandId: "matchmaking/list";
+}
+interface MatchmakingListOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/list";
+    status: "success";
+    data: MatchmakingListOkResponseData;
+}
+interface MatchmakingListOkResponseData {
+    playlists: {
+        id: string;
+        name: string;
+        numOfTeams: number;
+        teamSize: number;
+        ranked: boolean;
+    }[];
+}
+interface MatchmakingListFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/list";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface MatchmakingLostEvent {
+    type: "event";
+    messageId: string;
+    commandId: "matchmaking/lost";
+}
+interface MatchmakingQueueRequest {
+    type: "request";
+    messageId: string;
+    commandId: "matchmaking/queue";
+    data: MatchmakingQueueRequestData;
+}
+interface MatchmakingQueueRequestData {
+    queues: [string, ...string[]];
+}
+interface MatchmakingQueueOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/queue";
+    status: "success";
+}
+interface MatchmakingQueueFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/queue";
+    status: "failed";
+    reason: "invalid_queue_specified" | "already_queued" | "already_inbattle" | "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface MatchmakingQueueUpdateEvent {
+    type: "event";
+    messageId: string;
+    commandId: "matchmaking/queueUpdate";
+    data: MatchmakingQueueUpdateEventData;
+}
+interface MatchmakingQueueUpdateEventData {
+    playersQueued: string;
+}
+interface MatchmakingReadyRequest {
+    type: "request";
+    messageId: string;
+    commandId: "matchmaking/ready";
+}
+interface MatchmakingReadyOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/ready";
+    status: "success";
+}
+interface MatchmakingReadyFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "matchmaking/ready";
+    status: "failed";
+    reason: "no_match" | "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface MatchmakingReadyUpdateEvent {
+    type: "event";
+    messageId: string;
+    commandId: "matchmaking/readyUpdate";
+    data: MatchmakingReadyUpdateEventData;
+}
+interface MatchmakingReadyUpdateEventData {
+    readyMax: number;
+    readyCurrent: number;
+}
+interface SystemDisconnectRequest {
+    type: "request";
+    messageId: string;
+    commandId: "system/disconnect";
+    data?: SystemDisconnectRequestData;
+}
+interface SystemDisconnectRequestData {
+    reason: string;
+}
+interface SystemDisconnectOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "system/disconnect";
+    status: "success";
+}
+interface SystemDisconnectFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "system/disconnect";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface SystemServerStatsRequest {
+    type: "request";
+    messageId: string;
+    commandId: "system/serverStats";
+}
+interface SystemServerStatsOkResponse {
+    type: "response";
+    messageId: string;
+    commandId: "system/serverStats";
+    status: "success";
+    data: SystemServerStatsOkResponseData;
+}
+interface SystemServerStatsOkResponseData {
+    userCount: number;
+}
+interface SystemServerStatsFailResponse {
+    type: "response";
+    messageId: string;
+    commandId: "system/serverStats";
+    status: "failed";
+    reason: "internal_error" | "unauthorized" | "invalid_request" | "command_unimplemented";
+}
+interface UserUpdatedEvent {
+    type: "event";
+    messageId: string;
+    commandId: "user/updated";
+    data: UserUpdatedEventData;
+}
+interface UserUpdatedEventData {
+    users: ({
+        userId?: string;
+        username?: string;
+        displayName?: string;
+        clanId?: string | null;
+        partyId?: string | null;
+        scopes?: string[];
+        countryCode?: string;
+        status?: "offline" | "menu" | "playing" | "lobby";
+    } & {
+        friendIds?: string[];
+        outgoingFriendRequestIds?: string[];
+        incomingFriendRequestIds?: string[];
+        ignoreIds?: string[];
+    })[];
+}
+
+export type { AllyTeam, AutohostAddPlayerFailResponse, AutohostAddPlayerOkResponse, AutohostAddPlayerRequest, AutohostAddPlayerRequestData, AutohostAddPlayerResponse, AutohostKickPlayerFailResponse, AutohostKickPlayerOkResponse, AutohostKickPlayerRequest, AutohostKickPlayerRequestData, AutohostKickPlayerResponse, AutohostKillFailResponse, AutohostKillOkResponse, AutohostKillRequest, AutohostKillRequestData, AutohostKillResponse, AutohostMutePlayerFailResponse, AutohostMutePlayerOkResponse, AutohostMutePlayerRequest, AutohostMutePlayerRequestData, AutohostMutePlayerResponse, AutohostSendCommandFailResponse, AutohostSendCommandOkResponse, AutohostSendCommandRequest, AutohostSendCommandRequestData, AutohostSendCommandResponse, AutohostSendMessageFailResponse, AutohostSendMessageOkResponse, AutohostSendMessageRequest, AutohostSendMessageRequestData, AutohostSendMessageResponse, AutohostSpecPlayersFailResponse, AutohostSpecPlayersOkResponse, AutohostSpecPlayersRequest, AutohostSpecPlayersRequestData, AutohostSpecPlayersResponse, AutohostStartFailResponse, AutohostStartOkResponse, AutohostStartOkResponseData, AutohostStartRequest, AutohostStartRequestData, AutohostStartResponse, AutohostStatusEvent, AutohostStatusEventData, AutohostSubscribeUpdatesFailResponse, AutohostSubscribeUpdatesOkResponse, AutohostSubscribeUpdatesRequest, AutohostSubscribeUpdatesRequestData, AutohostSubscribeUpdatesResponse, AutohostUpdateEvent, AutohostUpdateEventData, BattleStartFailResponse, BattleStartOkResponse, BattleStartRequest, BattleStartRequestData, BattleStartResponse, Bot, CustomStartScriptProperties, EngineCrashUpdate, EngineMessageUpdate, EngineQuitUpdate, EngineWarningUpdate, FinishedUpdate, LuaMsgUpdate, MatchmakingCancelFailResponse, MatchmakingCancelOkResponse, MatchmakingCancelRequest, MatchmakingCancelResponse, MatchmakingFoundEvent, MatchmakingFoundEventData, MatchmakingFoundUpdateEvent, MatchmakingFoundUpdateEventData, MatchmakingListFailResponse, MatchmakingListOkResponse, MatchmakingListOkResponseData, MatchmakingListRequest, MatchmakingListResponse, MatchmakingLostEvent, MatchmakingQueueFailResponse, MatchmakingQueueOkResponse, MatchmakingQueueRequest, MatchmakingQueueRequestData, MatchmakingQueueResponse, MatchmakingQueueUpdateEvent, MatchmakingQueueUpdateEventData, MatchmakingReadyFailResponse, MatchmakingReadyOkResponse, MatchmakingReadyRequest, MatchmakingReadyResponse, MatchmakingReadyUpdateEvent, MatchmakingReadyUpdateEventData, Player, PlayerChatUpdate, PlayerDefeatedUpdate, PlayerJoinedUpdate, PlayerLeftUpdate, StartBox, StartPosType, StartUpdate, SystemDisconnectFailResponse, SystemDisconnectOkResponse, SystemDisconnectRequest, SystemDisconnectRequestData, SystemDisconnectResponse, SystemServerStatsFailResponse, SystemServerStatsOkResponse, SystemServerStatsOkResponseData, SystemServerStatsRequest, SystemServerStatsResponse, TachyonCommand, Team, UnixTime, UserId, UserUpdatedEvent, UserUpdatedEventData };

package/dist/types.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// dist/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);