From 9cf2f10ee9903c22ed34883c309671d30e7ab1a5 Mon Sep 17 00:00:00 2001 From: Rainnny7 Date: Mon, 15 Apr 2024 11:24:03 -0400 Subject: [PATCH] Export enums --- JS-SDK/src/index.d.ts | 5 +++-- JS-SDK/src/index.ts | 5 +++++ JS-SDK/src/lib/restfulmc.ts | 8 ++++---- .../types/{dns.d.ts => dns/dns-record.d.ts} | 10 ++-------- JS-SDK/src/types/dns/record-type.ts | 7 +++++++ JS-SDK/src/types/mojang.d.ts | 16 ---------------- .../types/mojang/server-status-response.d.ts | 7 +++++++ JS-SDK/src/types/mojang/server-status.ts | 8 ++++++++ JS-SDK/src/types/player/player.ts | 18 ++---------------- JS-SDK/src/types/player/profile-action.ts | 7 +++++++ JS-SDK/src/types/player/skin-model.ts | 7 +++++++ JS-SDK/src/types/server/bedrock/edition.ts | 7 +++++++ .../server.d.ts} | 9 +-------- JS-SDK/src/types/server/server.ts | 2 +- JS-SDK/test/server.test.ts | 2 +- 15 files changed, 62 insertions(+), 56 deletions(-) rename JS-SDK/src/types/{dns.d.ts => dns/dns-record.d.ts} (91%) create mode 100644 JS-SDK/src/types/dns/record-type.ts delete mode 100644 JS-SDK/src/types/mojang.d.ts create mode 100644 JS-SDK/src/types/mojang/server-status-response.d.ts create mode 100644 JS-SDK/src/types/mojang/server-status.ts create mode 100644 JS-SDK/src/types/player/profile-action.ts create mode 100644 JS-SDK/src/types/player/skin-model.ts create mode 100644 JS-SDK/src/types/server/bedrock/edition.ts rename JS-SDK/src/types/server/{bedrock-server.d.ts => bedrock/server.d.ts} (93%) diff --git a/JS-SDK/src/index.d.ts b/JS-SDK/src/index.d.ts index a970d85..0dbbf46 100644 --- a/JS-SDK/src/index.d.ts +++ b/JS-SDK/src/index.d.ts @@ -1,5 +1,6 @@ -export * from "./types/mojang"; +export * from "./types/dns/dns-record"; +export * from "./types/mojang/server-status-response"; export * from "./types/player/player"; -export * from "./types/server/bedrock-server"; +export * from "./types/server/bedrock/server"; export * from "./types/server/java-server"; export * from "./types/server/server"; diff --git a/JS-SDK/src/index.ts b/JS-SDK/src/index.ts index 25485be..d0d0b01 100644 --- a/JS-SDK/src/index.ts +++ b/JS-SDK/src/index.ts @@ -1,6 +1,11 @@ export * from "@/lib/restfulmc"; // Types +export * from "@/types/dns/record-type"; export * from "@/types/error"; +export * from "@/types/mojang/server-status"; +export * from "@/types/player/profile-action"; +export * from "@/types/player/skin-model"; export * from "@/types/player/skin-part"; +export * from "@/types/server/bedrock/edition"; export * from "@/types/server/platform"; diff --git a/JS-SDK/src/lib/restfulmc.ts b/JS-SDK/src/lib/restfulmc.ts index 60c5641..c7e968d 100644 --- a/JS-SDK/src/lib/restfulmc.ts +++ b/JS-SDK/src/lib/restfulmc.ts @@ -1,8 +1,8 @@ import { WebRequest } from "@/lib/web-request"; -import { MojangServerStatus } from "@/types/mojang"; +import { MojangServerStatusResponse } from "@/types/mojang/server-status-response"; import { CachedPlayer } from "@/types/player/player"; import { SkinPart } from "@/types/player/skin-part"; -import { CachedBedrockMinecraftServer } from "@/types/server/bedrock-server"; +import { CachedBedrockMinecraftServer } from "@/types/server/bedrock/server"; import { CachedJavaMinecraftServer } from "@/types/server/java-server"; import { ServerPlatform } from "@/types/server/platform"; @@ -83,5 +83,5 @@ export const getJavaServerFavicon = (hostname: string): Promise => * * @returns the promised status */ -export const getMojangServerStatus = (): Promise => - new WebRequest("/mojang/status").execute(); +export const getMojangServerStatus = (): Promise => + new WebRequest("/mojang/status").execute(); diff --git a/JS-SDK/src/types/dns.d.ts b/JS-SDK/src/types/dns/dns-record.d.ts similarity index 91% rename from JS-SDK/src/types/dns.d.ts rename to JS-SDK/src/types/dns/dns-record.d.ts index 8a356d1..9239cd1 100644 --- a/JS-SDK/src/types/dns.d.ts +++ b/JS-SDK/src/types/dns/dns-record.d.ts @@ -1,3 +1,5 @@ +import { RecordType } from "@/type/dns/record-type"; + /** * An A record. */ @@ -47,11 +49,3 @@ export type DNSRecord = { */ ttl: number; }; - -/** - * Types of a DNS record. - */ -enum RecordType { - A, - SRV, -} diff --git a/JS-SDK/src/types/dns/record-type.ts b/JS-SDK/src/types/dns/record-type.ts new file mode 100644 index 0000000..a8fba29 --- /dev/null +++ b/JS-SDK/src/types/dns/record-type.ts @@ -0,0 +1,7 @@ +/** + * Types of a DNS record. + */ +export enum RecordType { + A, + SRV, +} diff --git a/JS-SDK/src/types/mojang.d.ts b/JS-SDK/src/types/mojang.d.ts deleted file mode 100644 index bf518e1..0000000 --- a/JS-SDK/src/types/mojang.d.ts +++ /dev/null @@ -1,16 +0,0 @@ -/** - * Represents the status of - * a service provided by Mojang. - */ -export type MojangServerStatus = { - [endpoint: string]: Status; -}; - -/** - * The status of a service. - */ -enum Status { - ONLINE, - DEGRADED, - OFFLINE, -} diff --git a/JS-SDK/src/types/mojang/server-status-response.d.ts b/JS-SDK/src/types/mojang/server-status-response.d.ts new file mode 100644 index 0000000..8560579 --- /dev/null +++ b/JS-SDK/src/types/mojang/server-status-response.d.ts @@ -0,0 +1,7 @@ +/** + * Represents the status of + * a service provided by Mojang. + */ +export type MojangServerStatusResponse = { + [endpoint: string]: Status; +}; diff --git a/JS-SDK/src/types/mojang/server-status.ts b/JS-SDK/src/types/mojang/server-status.ts new file mode 100644 index 0000000..d08ff3f --- /dev/null +++ b/JS-SDK/src/types/mojang/server-status.ts @@ -0,0 +1,8 @@ +/** + * The status of a service. + */ +export enum Status { + ONLINE, + DEGRADED, + OFFLINE, +} diff --git a/JS-SDK/src/types/player/player.ts b/JS-SDK/src/types/player/player.ts index 2dd02a4..60e9801 100644 --- a/JS-SDK/src/types/player/player.ts +++ b/JS-SDK/src/types/player/player.ts @@ -1,3 +1,5 @@ +import { ProfileAction } from "@/types/player/profile-action"; +import { SkinModel } from "@/types/player/skin-model"; import { SkinPart } from "@/types/player/skin-part"; /** @@ -87,14 +89,6 @@ type Skin = { }; }; -/** - * Possible models for a skin. - */ -enum SkinModel { - DEFAULT, - SLIM, -} - /** * A cape for a {@link Player}. */ @@ -125,11 +119,3 @@ type ProfileProperty = { */ signature?: string | undefined; }; - -/** - * Profile actions that can - */ -enum ProfileAction { - FORCED_NAME_CHANGE, - USING_BANNED_SKIN, -} diff --git a/JS-SDK/src/types/player/profile-action.ts b/JS-SDK/src/types/player/profile-action.ts new file mode 100644 index 0000000..10e439e --- /dev/null +++ b/JS-SDK/src/types/player/profile-action.ts @@ -0,0 +1,7 @@ +/** + * Profile actions that can + */ +export enum ProfileAction { + FORCED_NAME_CHANGE, + USING_BANNED_SKIN, +} diff --git a/JS-SDK/src/types/player/skin-model.ts b/JS-SDK/src/types/player/skin-model.ts new file mode 100644 index 0000000..fda4f52 --- /dev/null +++ b/JS-SDK/src/types/player/skin-model.ts @@ -0,0 +1,7 @@ +/** + * Possible models for a skin. + */ +export enum SkinModel { + DEFAULT, + SLIM, +} diff --git a/JS-SDK/src/types/server/bedrock/edition.ts b/JS-SDK/src/types/server/bedrock/edition.ts new file mode 100644 index 0000000..eb7d7e4 --- /dev/null +++ b/JS-SDK/src/types/server/bedrock/edition.ts @@ -0,0 +1,7 @@ +/** + * The edition of a Bedrock server. + */ +export enum Edition { + MCPE, + MCEE, +} diff --git a/JS-SDK/src/types/server/bedrock-server.d.ts b/JS-SDK/src/types/server/bedrock/server.d.ts similarity index 93% rename from JS-SDK/src/types/server/bedrock-server.d.ts rename to JS-SDK/src/types/server/bedrock/server.d.ts index 1a07d44..bd48a23 100644 --- a/JS-SDK/src/types/server/bedrock-server.d.ts +++ b/JS-SDK/src/types/server/bedrock/server.d.ts @@ -1,3 +1,4 @@ +import { Edition } from "@/types/server/bedrock/edition"; import { MinecraftServer } from "@/types/server/server"; /** @@ -36,14 +37,6 @@ export interface BedrockMinecraftServer extends MinecraftServer { gamemode: GameMode; } -/** - * The edition of a Bedrock server. - */ -enum Edition { - MCPE, - MCEE, -} - /** * Version information for a server. */ diff --git a/JS-SDK/src/types/server/server.ts b/JS-SDK/src/types/server/server.ts index a3e4d03..b4bfa67 100644 --- a/JS-SDK/src/types/server/server.ts +++ b/JS-SDK/src/types/server/server.ts @@ -1,4 +1,4 @@ -import { ARecord, SRVRecord } from "@/types/dns"; +import { ARecord, SRVRecord } from "@/types/dns/dns-record"; /** * A model representing a Minecraft server. diff --git a/JS-SDK/test/server.test.ts b/JS-SDK/test/server.test.ts index e726ef6..50c62f1 100644 --- a/JS-SDK/test/server.test.ts +++ b/JS-SDK/test/server.test.ts @@ -5,7 +5,7 @@ import { isMojangBlocked, } from "@/index"; import { RestfulMCAPIError } from "@/types/error"; -import { CachedBedrockMinecraftServer } from "@/types/server/bedrock-server"; +import { CachedBedrockMinecraftServer } from "@/types/server/bedrock/server"; import { CachedJavaMinecraftServer } from "@/types/server/java-server"; import { expect, test } from "bun:test";