@modrinth/api-client 0.50.0 → 0.52.0

package/dist/index.d.ts

@@ -278,6 +278,7 @@ export declare abstract class AbstractWebSocketClient {
     protected readonly MAX_RECONNECT_ATTEMPTS = 10;
     protected readonly RECONNECT_BASE_DELAY = 1000;
     protected readonly RECONNECT_MAX_DELAY = 30000;
+    protected readonly AUTHENTICATION_TIMEOUT = 30000;
     constructor(client: {
         archon: {
             servers_v0: {
@@ -292,6 +293,7 @@ export declare abstract class AbstractWebSocketClient {
     safeConnect(serverId: string, options?: {
         force?: boolean;
     }): Promise<void>;
+    protected waitForAuthentication(serverId: string): Promise<void>;
     on<E extends Archon.Websocket.v0.WSEventType>(serverId: string, eventType: E, handler: WebSocketEventHandler<Extract<Archon.Websocket.v0.WSEvent, {
         event: E;
     }>>): () => void;
@@ -543,13 +545,20 @@ export declare namespace Archon {
                 name: string | null;
                 environment?: Labrinth.Projects.v3.Environment | null;
             };
+            export type AddonStatus = 'pending' | 'installed' | {
+                failed: {
+                    error: string;
+                };
+            };
             export type Addon = {
                 id: string;
                 filename: string;
                 filesize: number;
+                btime?: string;
                 disabled: boolean;
                 kind: AddonKind;
                 from_modpack: boolean;
+                status: AddonStatus;
                 pack_client_retained: boolean;
                 pack_client_depends: boolean;
                 has_update: string | null;
@@ -564,6 +573,10 @@ export declare namespace Archon {
                 modloader_version: string | null;
                 game_version: string | null;
                 modpack: ModpackFields | null;
+                installing?: 'loader' | 'modpack';
+                error?: {
+                    message: string;
+                };
                 addons: Addon[] | null;
             };
             export type AddAddonRequest = {
@@ -1122,7 +1135,69 @@ export declare namespace Archon {
                 world_id: string;
                 spec: Archon.Content.v1.Addons;
             };
-            export type SyncEvent = ProtocolResetEvent | ProtocolInvalidEvent | ProtocolErrorEvent | BackupNewEvent | BackupPatchEvent | BackupDeleteEvent | BackupOperationStartEvent | BackupOperationDoneEvent | ServerPatchEvent | ServerNetworkPatchEvent | ServerTransferEvent | UsersPatchEvent | WorldPatchEvent | WorldStartupPatchEvent | WorldContentAddonPatchEvent | WorldContentBaseUpdateEvent;
+            export type WorldContentPlatform = 'forge' | 'neoforge' | 'fabric' | 'quilt' | 'paper' | 'purpur' | 'vanilla';
+            export type WorldContentPlatformData = {
+                platform: WorldContentPlatform;
+                game_version: string;
+                platform_version: string | null;
+            };
+            export type WorldContentModpackSource = 'CurseForge' | {
+                Modrinth: {
+                    version_id: string;
+                    project_id: string;
+                    mrpack_sha1: string | null;
+                };
+            } | {
+                LocalMrPackFile: {
+                    path: string;
+                    name: string;
+                    description: string | null;
+                    version_name: string | null;
+                };
+            };
+            export type WorldContentModpack = {
+                spec: WorldContentModpackSource;
+                downloads: number | null;
+                followers: number | null;
+                icon_url: string | null;
+                owner: Archon.Content.v1.ContentOwner | null;
+                title: string | null;
+                description: string | null;
+                version_number: string | null;
+                date_published: string | null;
+                environment: Labrinth.Projects.v3.Environment | null;
+                has_update: string | null;
+            };
+            export type WorldContentItem = {
+                parent_directory: string;
+                file_sha1: string | null;
+                filename: string;
+                btime?: string;
+                from_modpack: boolean;
+                version_id: string | null;
+                project_id: string | null;
+                pack_client_retained: boolean;
+                pack_client_depends: boolean;
+                status: Archon.Content.v1.AddonStatus;
+                filesize: number | null;
+                name: string | null;
+                version: Archon.Content.v1.AddonVersion | null;
+                owner: Archon.Content.v1.ContentOwner | null;
+                has_update: string | null;
+                icon_url: string | null;
+            };
+            export type WorldContentUpdateEvent = {
+                type: 'world.content.update';
+                world_id: string;
+                platform_data: WorldContentPlatformData | null;
+                linked_modpack: WorldContentModpack | null;
+                installing?: 'loader' | 'modpack';
+                error?: {
+                    message: string;
+                };
+                content: WorldContentItem[];
+            };
+            export type SyncEvent = ProtocolResetEvent | ProtocolInvalidEvent | ProtocolErrorEvent | BackupNewEvent | BackupPatchEvent | BackupDeleteEvent | BackupOperationStartEvent | BackupOperationDoneEvent | ServerPatchEvent | ServerNetworkPatchEvent | ServerTransferEvent | UsersPatchEvent | WorldPatchEvent | WorldStartupPatchEvent | WorldContentAddonPatchEvent | WorldContentBaseUpdateEvent | WorldContentUpdateEvent;
         }
     }
     export namespace Websocket {
@@ -1201,6 +1276,42 @@ export declare namespace Archon {
                 project_id: string;
                 version_id: string;
             };
+            export type InstallProgressFileKey = {
+                type: 'file';
+                install_type: 'install' | 'update';
+                project_id: string;
+                version_id: string;
+                parent_directory: string;
+                source_filename: string | null;
+                target_filename?: string | null;
+            };
+            export type InstallProgressModrinthModpackKey = {
+                type: 'modrinth_modpack';
+                project_id: string;
+                version_id: string;
+            };
+            export type InstallProgressLocalModpackKey = {
+                type: 'local_modpack';
+                filename: string;
+            };
+            export type InstallProgressPlatformKey = {
+                type: 'platform';
+                platform: 'forge' | 'neoforge' | 'fabric' | 'quilt' | 'paper' | 'purpur' | 'vanilla';
+                platform_version: string;
+                game_version: string;
+            };
+            export type InstallProgressKey = InstallProgressFileKey | InstallProgressModrinthModpackKey | InstallProgressLocalModpackKey | InstallProgressPlatformKey;
+            export type InstallProgressItem = {
+                world_id: string;
+                key: InstallProgressKey;
+                id: string;
+                progress: number | null;
+                error: string | null;
+            };
+            export type WSInstallProgressEvent = {
+                event: 'install-progress';
+                items: InstallProgressItem[];
+            };
             export type FilesystemOpKind = 'unarchive';
             export type FilesystemOpState = 'queued' | 'ongoing' | 'done' | 'cancelled' | 'failure-corrupted' | 'failure-invalid-path';
             export type FilesystemOperation = {
@@ -1256,7 +1367,7 @@ export declare namespace Archon {
                 event: 'command';
                 cmd: string;
             };
-            export type WSEvent = WSBackupProgressEvent | WSLogEvent | WSLog4jEvent | WSStatsEvent | WSPowerStateEvent | WSStateEvent | WSAuthExpiringEvent | WSAuthIncorrectEvent | WSAuthOkEvent | WSInstallationResultEvent | WSUptimeEvent | WSNewModEvent | WSFilesystemOpsEvent;
+            export type WSEvent = WSBackupProgressEvent | WSLogEvent | WSLog4jEvent | WSStatsEvent | WSPowerStateEvent | WSStateEvent | WSAuthExpiringEvent | WSAuthIncorrectEvent | WSAuthOkEvent | WSInstallationResultEvent | WSUptimeEvent | WSNewModEvent | WSInstallProgressEvent | WSFilesystemOpsEvent;
             export type WSEventType = WSEvent['event'];
         }
     }
@@ -3884,7 +3995,7 @@ export declare namespace Labrinth {
         }
         export namespace v3 {
             export interface ResultSearchProject {
-                version_id: string;
+                version_id?: string;
                 project_id: string;
                 project_types: string[];
                 all_project_types: string[];
@@ -7405,6 +7516,7 @@ export declare class VerboseLoggingFeature extends AbstractFeature {
 export declare interface WebSocketConnection {
     serverId: string;
     socket: WebSocket;
+    authenticated: boolean;
     reconnectAttempts: number;
     reconnectTimer?: ReturnType<typeof setTimeout>;
     isReconnecting: boolean;