@fungi.computer/agar 0.0.0-stage → 0.0.1

package/dist/game-servers.d.ts

@@ -0,0 +1,530 @@
+import * as z from "zod";
+import type { CapabilityContract, CapabilityDirectory } from "./capabilities.js";
+/** The games supported by the on-box controller's current catalog. */
+export declare const gameIdSchema: z.ZodEnum<{
+    minecraft: "minecraft";
+    terraria: "terraria";
+    factorio: "factorio";
+    valheim: "valheim";
+    "project-zomboid": "project-zomboid";
+}>;
+export type GameId = z.output<typeof gameIdSchema>;
+export declare const gameServerSizeTierSchema: z.ZodEnum<{
+    squad: "squad";
+    raid: "raid";
+}>;
+export type GameServerSizeTier = z.output<typeof gameServerSizeTierSchema>;
+export declare const gameServerSizes: {
+    readonly minecraft: {
+        readonly squad: {
+            readonly memoryMiB: 2048;
+            readonly vcpuCount: 1;
+        };
+        readonly raid: {
+            readonly memoryMiB: 4096;
+            readonly vcpuCount: 2;
+        };
+    };
+    readonly terraria: {
+        readonly squad: {
+            readonly memoryMiB: 2048;
+            readonly vcpuCount: 1;
+        };
+        readonly raid: {
+            readonly memoryMiB: 4096;
+            readonly vcpuCount: 2;
+        };
+    };
+    readonly factorio: {
+        readonly squad: {
+            readonly memoryMiB: 3072;
+            readonly vcpuCount: 1;
+        };
+        readonly raid: {
+            readonly memoryMiB: 6144;
+            readonly vcpuCount: 2;
+        };
+    };
+    readonly valheim: {
+        readonly squad: {
+            readonly memoryMiB: 4096;
+            readonly vcpuCount: 2;
+        };
+        readonly raid: {
+            readonly memoryMiB: 6144;
+            readonly vcpuCount: 3;
+        };
+    };
+    readonly "project-zomboid": {
+        readonly squad: {
+            readonly memoryMiB: 8192;
+            readonly vcpuCount: 2;
+        };
+        readonly raid: {
+            readonly memoryMiB: 12288;
+            readonly vcpuCount: 3;
+        };
+    };
+};
+export declare const gameServerBillingModeSchema: z.ZodEnum<{
+    "insert-coin": "insert-coin";
+    hardcore: "hardcore";
+}>;
+export type GameServerBillingMode = z.output<typeof gameServerBillingModeSchema>;
+export declare const gameServerPassIdSchema: z.ZodEnum<{
+    "booster-pack": "booster-pack";
+    "battle-pass": "battle-pass";
+}>;
+export type GameServerPassId = z.output<typeof gameServerPassIdSchema>;
+export declare const gameServerSizeSchema: z.ZodObject<{
+    tier: z.ZodEnum<{
+        squad: "squad";
+        raid: "raid";
+    }>;
+    memoryMiB: z.ZodNumber;
+    vcpuCount: z.ZodNumber;
+}, z.core.$strict>;
+export type GameServerSize = z.output<typeof gameServerSizeSchema>;
+export declare const gameServerBackupSchema: z.ZodObject<{
+    backupId: z.ZodString;
+    createdAt: z.ZodNumber;
+    sizeBytes: z.ZodNumber;
+}, z.core.$strict>;
+export type GameServerBackup = z.output<typeof gameServerBackupSchema>;
+export declare const gameServerCatalogSchema: z.ZodObject<{
+    games: z.ZodArray<z.ZodObject<{
+        game: z.ZodEnum<{
+            minecraft: "minecraft";
+            terraria: "terraria";
+            factorio: "factorio";
+            valheim: "valheim";
+            "project-zomboid": "project-zomboid";
+        }>;
+        variants: z.ZodArray<z.ZodString>;
+        sizes: z.ZodObject<{
+            squad: z.ZodObject<{
+                size: z.ZodObject<{
+                    tier: z.ZodEnum<{
+                        squad: "squad";
+                        raid: "raid";
+                    }>;
+                    memoryMiB: z.ZodNumber;
+                    vcpuCount: z.ZodNumber;
+                }, z.core.$strict>;
+                hourlyPriceUsd: z.ZodNullable<z.ZodNumber>;
+                monthlyCapUsd: z.ZodNullable<z.ZodNumber>;
+                hardcoreMonthlyPriceUsd: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strict>;
+            raid: z.ZodObject<{
+                size: z.ZodObject<{
+                    tier: z.ZodEnum<{
+                        squad: "squad";
+                        raid: "raid";
+                    }>;
+                    memoryMiB: z.ZodNumber;
+                    vcpuCount: z.ZodNumber;
+                }, z.core.$strict>;
+                hourlyPriceUsd: z.ZodNullable<z.ZodNumber>;
+                monthlyCapUsd: z.ZodNullable<z.ZodNumber>;
+                hardcoreMonthlyPriceUsd: z.ZodNullable<z.ZodNumber>;
+            }, z.core.$strict>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    pricing: z.ZodNullable<z.ZodObject<{
+        labels: z.ZodObject<{
+            modes: z.ZodObject<{
+                insertCoin: z.ZodString;
+                hardcore: z.ZodString;
+            }, z.core.$strict>;
+            sizes: z.ZodObject<{
+                squad: z.ZodString;
+                raid: z.ZodString;
+            }, z.core.$strict>;
+            passes: z.ZodObject<{
+                "booster-pack": z.ZodString;
+                "battle-pass": z.ZodString;
+            }, z.core.$strict>;
+        }, z.core.$strict>;
+        passes: z.ZodArray<z.ZodObject<{
+            id: z.ZodEnum<{
+                "booster-pack": "booster-pack";
+                "battle-pass": "battle-pass";
+            }>;
+            displayName: z.ZodString;
+            monthlyPriceUsd: z.ZodNumber;
+            playerHours: z.ZodNumber;
+            serverLimit: z.ZodNumber;
+            eligibleGames: z.ZodArray<z.ZodEnum<{
+                minecraft: "minecraft";
+                terraria: "terraria";
+                factorio: "factorio";
+                valheim: "valheim";
+                "project-zomboid": "project-zomboid";
+            }>>;
+            includesRaid: z.ZodBoolean;
+            includedWithPro: z.ZodBoolean;
+        }, z.core.$strict>>;
+        alwaysOnMemoryCapMiB: z.ZodNumber;
+    }, z.core.$strict>>;
+    creditRemainingUsd: z.ZodNumber;
+}, z.core.$strict>;
+export type GameServerCatalog = z.output<typeof gameServerCatalogSchema>;
+export declare const gameServerStateSchema: z.ZodObject<{
+    serverId: z.ZodString;
+    teamId: z.ZodString;
+    name: z.ZodString;
+    game: z.ZodEnum<{
+        minecraft: "minecraft";
+        terraria: "terraria";
+        factorio: "factorio";
+        valheim: "valheim";
+        "project-zomboid": "project-zomboid";
+    }>;
+    variant: z.ZodString;
+    size: z.ZodObject<{
+        tier: z.ZodEnum<{
+            squad: "squad";
+            raid: "raid";
+        }>;
+        memoryMiB: z.ZodNumber;
+        vcpuCount: z.ZodNumber;
+    }, z.core.$strict>;
+    billingMode: z.ZodEnum<{
+        "insert-coin": "insert-coin";
+        hardcore: "hardcore";
+    }>;
+    passId: z.ZodNullable<z.ZodEnum<{
+        "booster-pack": "booster-pack";
+        "battle-pass": "battle-pass";
+    }>>;
+    tunnelStatus: z.ZodEnum<{
+        configured: "configured";
+        not_configured: "not_configured";
+    }>;
+    desiredState: z.ZodEnum<{
+        running: "running";
+        stopped: "stopped";
+    }>;
+    phase: z.ZodEnum<{
+        failed: "failed";
+        sleeping: "sleeping";
+        starting: "starting";
+        stopped: "stopped";
+        awake: "awake";
+    }>;
+    players: z.ZodNumber;
+    maxPlayers: z.ZodNullable<z.ZodNumber>;
+    connections: z.ZodArray<z.ZodObject<{
+        purpose: z.ZodString;
+        protocol: z.ZodEnum<{
+            tcp: "tcp";
+            udp: "udp";
+        }>;
+        host: z.ZodString;
+        port: z.ZodNumber;
+    }, z.core.$strict>>;
+    version: z.ZodNumber;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+}, z.core.$strict>;
+export type GameServerState = z.output<typeof gameServerStateSchema>;
+export declare const gameServerSchema: z.ZodObject<{
+    serverId: z.ZodString;
+    teamId: z.ZodString;
+    name: z.ZodString;
+    game: z.ZodEnum<{
+        minecraft: "minecraft";
+        terraria: "terraria";
+        factorio: "factorio";
+        valheim: "valheim";
+        "project-zomboid": "project-zomboid";
+    }>;
+    variant: z.ZodString;
+    size: z.ZodObject<{
+        tier: z.ZodEnum<{
+            squad: "squad";
+            raid: "raid";
+        }>;
+        memoryMiB: z.ZodNumber;
+        vcpuCount: z.ZodNumber;
+    }, z.core.$strict>;
+    billingMode: z.ZodEnum<{
+        "insert-coin": "insert-coin";
+        hardcore: "hardcore";
+    }>;
+    passId: z.ZodNullable<z.ZodEnum<{
+        "booster-pack": "booster-pack";
+        "battle-pass": "battle-pass";
+    }>>;
+    tunnelStatus: z.ZodEnum<{
+        configured: "configured";
+        not_configured: "not_configured";
+    }>;
+    desiredState: z.ZodEnum<{
+        running: "running";
+        stopped: "stopped";
+    }>;
+    phase: z.ZodEnum<{
+        failed: "failed";
+        sleeping: "sleeping";
+        starting: "starting";
+        stopped: "stopped";
+        awake: "awake";
+    }>;
+    players: z.ZodNumber;
+    maxPlayers: z.ZodNullable<z.ZodNumber>;
+    connections: z.ZodArray<z.ZodObject<{
+        purpose: z.ZodString;
+        protocol: z.ZodEnum<{
+            tcp: "tcp";
+            udp: "udp";
+        }>;
+        host: z.ZodString;
+        port: z.ZodNumber;
+    }, z.core.$strict>>;
+    version: z.ZodNumber;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+    monthToDateCostUsd: z.ZodNumber;
+    teamMonthToDateCostUsd: z.ZodNumber;
+}, z.core.$strict>;
+export type GameServer = z.output<typeof gameServerSchema>;
+/** Passwords are write-only and never appear in GameServer or catalog responses. */
+export type GameServerCreate = Readonly<{
+    name: string;
+    variant: string;
+    requestId: string;
+    sizeTier: GameServerSizeTier;
+    billingMode: z.output<typeof gameServerBillingModeSchema>;
+    passId: z.output<typeof gameServerPassIdSchema> | null;
+}> & ({
+    game: "minecraft";
+    settings: {
+        eulaAcceptedByOperator: true;
+        onlineMode?: boolean;
+    };
+} | {
+    game: "terraria" | "factorio";
+    settings: Record<string, never>;
+} | {
+    game: "valheim";
+    settings: {
+        password: string;
+    };
+} | {
+    game: "project-zomboid";
+    settings: {
+        adminPassword: string;
+    };
+});
+export type GameServerAction = Readonly<{
+    serverId: string;
+    requestId: string;
+}>;
+export declare const gameServerPageSchema: z.ZodObject<{
+    servers: z.ZodArray<z.ZodObject<{
+        serverId: z.ZodString;
+        teamId: z.ZodString;
+        name: z.ZodString;
+        game: z.ZodEnum<{
+            minecraft: "minecraft";
+            terraria: "terraria";
+            factorio: "factorio";
+            valheim: "valheim";
+            "project-zomboid": "project-zomboid";
+        }>;
+        variant: z.ZodString;
+        size: z.ZodObject<{
+            tier: z.ZodEnum<{
+                squad: "squad";
+                raid: "raid";
+            }>;
+            memoryMiB: z.ZodNumber;
+            vcpuCount: z.ZodNumber;
+        }, z.core.$strict>;
+        billingMode: z.ZodEnum<{
+            "insert-coin": "insert-coin";
+            hardcore: "hardcore";
+        }>;
+        passId: z.ZodNullable<z.ZodEnum<{
+            "booster-pack": "booster-pack";
+            "battle-pass": "battle-pass";
+        }>>;
+        tunnelStatus: z.ZodEnum<{
+            configured: "configured";
+            not_configured: "not_configured";
+        }>;
+        desiredState: z.ZodEnum<{
+            running: "running";
+            stopped: "stopped";
+        }>;
+        phase: z.ZodEnum<{
+            failed: "failed";
+            sleeping: "sleeping";
+            starting: "starting";
+            stopped: "stopped";
+            awake: "awake";
+        }>;
+        players: z.ZodNumber;
+        maxPlayers: z.ZodNullable<z.ZodNumber>;
+        connections: z.ZodArray<z.ZodObject<{
+            purpose: z.ZodString;
+            protocol: z.ZodEnum<{
+                tcp: "tcp";
+                udp: "udp";
+            }>;
+            host: z.ZodString;
+            port: z.ZodNumber;
+        }, z.core.$strict>>;
+        version: z.ZodNumber;
+        createdAt: z.ZodNumber;
+        updatedAt: z.ZodNumber;
+        monthToDateCostUsd: z.ZodNumber;
+        teamMonthToDateCostUsd: z.ZodNumber;
+    }, z.core.$strict>>;
+    nextOffset: z.ZodNullable<z.ZodNumber>;
+    teamMonthToDateCostUsd: z.ZodNumber;
+}, z.core.$strict>;
+export type GameServerPage = z.output<typeof gameServerPageSchema>;
+export declare const gameServerErrorCodeSchema: z.ZodEnum<{
+    unavailable: "unavailable";
+    denied: "denied";
+    conflict: "conflict";
+    not_found: "not_found";
+    credit_exhausted: "credit_exhausted";
+    pricing_not_configured: "pricing_not_configured";
+    pass_not_included: "pass_not_included";
+    pass_not_active: "pass_not_active";
+    pass_game_not_eligible: "pass_game_not_eligible";
+    pass_size_not_eligible: "pass_size_not_eligible";
+    pass_server_limit: "pass_server_limit";
+    pass_mode_incompatible: "pass_mode_incompatible";
+    always_on_capacity: "always_on_capacity";
+    capacity: "capacity";
+    tunnel_unavailable: "tunnel_unavailable";
+    unsupported_variant: "unsupported_variant";
+}>;
+export type GameServerErrorCode = z.output<typeof gameServerErrorCodeSchema>;
+/** Versioned command delivered from the Team projection outbox to the box. */
+export declare const gameServerHostCommandSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"create">;
+    schemaVersion: z.ZodLiteral<1>;
+    teamId: z.ZodString;
+    serverId: z.ZodString;
+    version: z.ZodNumber;
+    game: z.ZodEnum<{
+        minecraft: "minecraft";
+        terraria: "terraria";
+        factorio: "factorio";
+        valheim: "valheim";
+        "project-zomboid": "project-zomboid";
+    }>;
+    variant: z.ZodString;
+    sizeTier: z.ZodEnum<{
+        squad: "squad";
+        raid: "raid";
+    }>;
+    billingMode: z.ZodEnum<{
+        "insert-coin": "insert-coin";
+        hardcore: "hardcore";
+    }>;
+    passId: z.ZodNullable<z.ZodEnum<{
+        "booster-pack": "booster-pack";
+        "battle-pass": "battle-pass";
+    }>>;
+    settings: z.ZodUnion<readonly [z.ZodObject<{
+        eulaAcceptedByOperator: z.ZodLiteral<true>;
+        onlineMode: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>, z.ZodObject<{
+        password: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{
+        adminPassword: z.ZodString;
+    }, z.core.$strict>, z.ZodObject<{}, z.core.$strict>]>;
+}, z.core.$strict>, ...z.ZodObject<{
+    kind: z.ZodLiteral<"start" | "stop" | "delete" | "backup-now">;
+    schemaVersion: z.ZodLiteral<1>;
+    teamId: z.ZodString;
+    serverId: z.ZodString;
+    version: z.ZodNumber;
+}, z.core.$strict>[], z.ZodObject<{
+    kind: z.ZodLiteral<"restore">;
+    schemaVersion: z.ZodLiteral<1>;
+    teamId: z.ZodString;
+    serverId: z.ZodString;
+    version: z.ZodNumber;
+    backupId: z.ZodString;
+}, z.core.$strict>], "kind">;
+export type GameServerHostCommand = z.output<typeof gameServerHostCommandSchema>;
+/** Signed host observation; sequence and version reject stale or replayed reports. */
+export declare const gameServerHostReportSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    hostId: z.ZodString;
+    teamId: z.ZodString;
+    serverId: z.ZodString;
+    version: z.ZodNumber;
+    sequence: z.ZodNumber;
+    observedAt: z.ZodNumber;
+    phase: z.ZodEnum<{
+        failed: "failed";
+        sleeping: "sleeping";
+        starting: "starting";
+        stopped: "stopped";
+        awake: "awake";
+    }>;
+    players: z.ZodNumber;
+    maxPlayers: z.ZodNullable<z.ZodNumber>;
+    connections: z.ZodArray<z.ZodObject<{
+        purpose: z.ZodString;
+        protocol: z.ZodEnum<{
+            tcp: "tcp";
+            udp: "udp";
+        }>;
+        host: z.ZodString;
+        port: z.ZodNumber;
+    }, z.core.$strict>>;
+    tunnelStatus: z.ZodEnum<{
+        configured: "configured";
+        not_configured: "not_configured";
+    }>;
+    backups: z.ZodArray<z.ZodObject<{
+        backupId: z.ZodString;
+        createdAt: z.ZodNumber;
+        sizeBytes: z.ZodNumber;
+    }, z.core.$strict>>;
+    runtime: z.ZodNullable<z.ZodObject<{
+        runtimeId: z.ZodString;
+        startedAt: z.ZodNumber;
+        ended: z.ZodBoolean;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type GameServerHostReport = z.output<typeof gameServerHostReportSchema>;
+/** A public or App game-server request refused by the Team decision. */
+export declare class GameServerRequestError extends Error {
+    readonly code: GameServerErrorCode;
+    readonly status: number;
+    constructor(code: GameServerErrorCode, status: number);
+}
+/** Ordinary App capability, granted by the Team to any declared App. */
+export type GameServersHandle = {
+    list(input?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<GameServerPage>;
+    catalog(): Promise<GameServerCatalog>;
+    create(input: GameServerCreate): Promise<GameServer>;
+    status(serverId: string): Promise<GameServer>;
+    start(input: GameServerAction): Promise<GameServer>;
+    stop(input: GameServerAction): Promise<GameServer>;
+    delete(input: GameServerAction): Promise<void>;
+    backups(serverId: string): Promise<readonly GameServerBackup[]>;
+    backupNow(input: GameServerAction): Promise<void>;
+    restore(input: GameServerAction & {
+        backupId: string;
+    }): Promise<GameServer>;
+};
+export declare const gamesServers: CapabilityContract<GameServersHandle>;
+/** Decode the host's listing at the App boundary. */
+export declare function listGameServers(capabilities: CapabilityDirectory, input?: {
+    limit?: number;
+    offset?: number;
+}): Promise<GameServerPage>;