@ejercito-fam/habbo-api 1.0.0 → 1.0.2

package/README.md

@@ -1,9 +1,17 @@
-# Bot
+# `@ejercito-fam/habbo-api`
 
-## Setup
+```ts
+import { Habbo, HotelDomainURL } from '@ejercito-fam/habbo-api';
 
-To manage dependencies, it is recommended to use Yarn, using `yarn --immutable` to install dependencies.
+// Initialize the client:
+const client = new Habbo({
+	baseURL: HotelDomainURL.Spanish
+});
 
-Create a `.env.development.local` file inside the `src` directory, copying the template from the `.env` file in the same
-directory, and then fill in the fields. The ENV loader is powered by
-[`@skyra/env-utilities`](https://www.npmjs.com/package/@skyra/env-utilities), more information in the package.
+// Fetch a user by its username:
+const result = await client.users.getByUsername('-tobi-talent-');
+
+// Log the user:
+const user = result.unwrap();
+console.log(user);
+```

package/dist/constants.d.ts

@@ -0,0 +1,25 @@
+export declare enum HotelDomainTLD {
+    Brazilian = ".com.br",
+    Danish = ".dk",
+    Dutch = ".nl",
+    Finnish = ".fi",
+    French = ".fr",
+    German = ".de",
+    International = ".com",
+    Italian = ".it",
+    Spanish = ".es",
+    Turkish = ".com.tr"
+}
+export declare const HotelDomainURL: {
+    readonly Brazilian: "https://www.habbo.com.br";
+    readonly Danish: "https://www.habbo.dk";
+    readonly Dutch: "https://www.habbo.nl";
+    readonly Finnish: "https://www.habbo.fi";
+    readonly French: "https://www.habbo.fr";
+    readonly German: "https://www.habbo.de";
+    readonly International: "https://www.habbo.com";
+    readonly Italian: "https://www.habbo.it";
+    readonly Spanish: "https://www.habbo.es";
+    readonly Turkish: "https://www.habbo.com.tr";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACzB,SAAS,YAAY;IACrB,MAAM,QAAQ;IACd,KAAK,QAAQ;IACb,OAAO,QAAQ;IACf,MAAM,QAAQ;IACd,MAAM,QAAQ;IACd,aAAa,SAAS;IACtB,OAAO,QAAQ;IACf,OAAO,QAAQ;IACf,OAAO,YAAY;CACnB;AAED,eAAO,MAAM,cAAc;;;;;;;;;;;CAWjB,CAAC"}

package/dist/constants.js

@@ -0,0 +1,26 @@
+export var HotelDomainTLD;
+(function (HotelDomainTLD) {
+    HotelDomainTLD["Brazilian"] = ".com.br";
+    HotelDomainTLD["Danish"] = ".dk";
+    HotelDomainTLD["Dutch"] = ".nl";
+    HotelDomainTLD["Finnish"] = ".fi";
+    HotelDomainTLD["French"] = ".fr";
+    HotelDomainTLD["German"] = ".de";
+    HotelDomainTLD["International"] = ".com";
+    HotelDomainTLD["Italian"] = ".it";
+    HotelDomainTLD["Spanish"] = ".es";
+    HotelDomainTLD["Turkish"] = ".com.tr";
+})(HotelDomainTLD || (HotelDomainTLD = {}));
+export const HotelDomainURL = {
+    Brazilian: `https://www.habbo${HotelDomainTLD.Brazilian}`,
+    Danish: `https://www.habbo${HotelDomainTLD.Danish}`,
+    Dutch: `https://www.habbo${HotelDomainTLD.Dutch}`,
+    Finnish: `https://www.habbo${HotelDomainTLD.Finnish}`,
+    French: `https://www.habbo${HotelDomainTLD.French}`,
+    German: `https://www.habbo${HotelDomainTLD.German}`,
+    International: `https://www.habbo${HotelDomainTLD.International}`,
+    Italian: `https://www.habbo${HotelDomainTLD.Italian}`,
+    Spanish: `https://www.habbo${HotelDomainTLD.Spanish}`,
+    Turkish: `https://www.habbo${HotelDomainTLD.Turkish}`
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,cAWX;AAXD,WAAY,cAAc;IACzB,uCAAqB,CAAA;IACrB,gCAAc,CAAA;IACd,+BAAa,CAAA;IACb,iCAAe,CAAA;IACf,gCAAc,CAAA;IACd,gCAAc,CAAA;IACd,wCAAsB,CAAA;IACtB,iCAAe,CAAA;IACf,iCAAe,CAAA;IACf,qCAAmB,CAAA;AACpB,CAAC,EAXW,cAAc,KAAd,cAAc,QAWzB;AAED,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B,SAAS,EAAE,oBAAoB,cAAc,CAAC,SAAS,EAAE;IACzD,MAAM,EAAE,oBAAoB,cAAc,CAAC,MAAM,EAAE;IACnD,KAAK,EAAE,oBAAoB,cAAc,CAAC,KAAK,EAAE;IACjD,OAAO,EAAE,oBAAoB,cAAc,CAAC,OAAO,EAAE;IACrD,MAAM,EAAE,oBAAoB,cAAc,CAAC,MAAM,EAAE;IACnD,MAAM,EAAE,oBAAoB,cAAc,CAAC,MAAM,EAAE;IACnD,aAAa,EAAE,oBAAoB,cAAc,CAAC,aAAa,EAAE;IACjE,OAAO,EAAE,oBAAoB,cAAc,CAAC,OAAO,EAAE;IACrD,OAAO,EAAE,oBAAoB,cAAc,CAAC,OAAO,EAAE;IACrD,OAAO,EAAE,oBAAoB,cAAc,CAAC,OAAO,EAAE;CAC5C,CAAC"}

package/dist/habbo.d.ts

@@ -0,0 +1,22 @@
+import { AchievementsAPI } from './routes/achievements.js';
+import { GroupsAPI } from './routes/groups.js';
+import { ListsAPI } from './routes/lists.js';
+import { MarketplaceAPI } from './routes/marketplace.js';
+import { PingAPI } from './routes/ping.js';
+import { RoomsAPI } from './routes/rooms.js';
+import { UsersAPI } from './routes/users.js';
+export declare class Habbo {
+    readonly achievements: AchievementsAPI;
+    readonly groups: GroupsAPI;
+    readonly lists: ListsAPI;
+    readonly marketplace: MarketplaceAPI;
+    readonly ping: PingAPI;
+    readonly rooms: RoomsAPI;
+    readonly users: UsersAPI;
+    constructor(options?: HabboOptions);
+}
+export interface HabboOptions {
+    baseURL?: string | null | undefined;
+    timeout?: number | null | undefined;
+}
+//# sourceMappingURL=habbo.d.ts.map

package/dist/habbo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"habbo.d.ts","sourceRoot":"","sources":["../src/habbo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,qBAAa,KAAK;IACjB,SAAgB,YAAY,EAAE,eAAe,CAAC;IAC9C,SAAgB,MAAM,EAAE,SAAS,CAAC;IAClC,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,SAAgB,WAAW,EAAE,cAAc,CAAC;IAC5C,SAAgB,IAAI,EAAE,OAAO,CAAC;IAC9B,SAAgB,KAAK,EAAE,QAAQ,CAAC;IAChC,SAAgB,KAAK,EAAE,QAAQ,CAAC;gBAEb,OAAO,CAAC,EAAE,YAAY;CAYzC;AAED,MAAM,WAAW,YAAY;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACpC"}

package/dist/habbo.js

@@ -0,0 +1,64 @@
+import { HotelDomainURL } from './constants.js';
+import { AchievementsAPI } from './routes/achievements.js';
+import { GroupsAPI } from './routes/groups.js';
+import { ListsAPI } from './routes/lists.js';
+import { MarketplaceAPI } from './routes/marketplace.js';
+import { PingAPI } from './routes/ping.js';
+import { RoomsAPI } from './routes/rooms.js';
+import { UsersAPI } from './routes/users.js';
+export class Habbo {
+    constructor(options) {
+        Object.defineProperty(this, "achievements", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "groups", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "lists", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "marketplace", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "ping", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "rooms", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "users", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        const baseURL = options?.baseURL ?? HotelDomainURL.International;
+        const timeout = options?.timeout ?? null;
+        this.achievements = new AchievementsAPI(baseURL, timeout);
+        this.groups = new GroupsAPI(baseURL, timeout);
+        this.lists = new ListsAPI(baseURL, timeout);
+        this.marketplace = new MarketplaceAPI(baseURL, timeout);
+        this.ping = new PingAPI(baseURL, timeout);
+        this.rooms = new RoomsAPI(baseURL, timeout);
+        this.users = new UsersAPI(baseURL, timeout);
+    }
+}
+//# sourceMappingURL=habbo.js.map

package/dist/habbo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"habbo.js","sourceRoot":"","sources":["../src/habbo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,MAAM,OAAO,KAAK;IASjB,YAAmB,OAAsB;QARzB;;;;;WAA8B;QAC9B;;;;;WAAkB;QAClB;;;;;WAAgB;QAChB;;;;;WAA4B;QAC5B;;;;;WAAc;QACd;;;;;WAAgB;QAChB;;;;;WAAgB;QAG/B,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,cAAc,CAAC,aAAa,CAAC;QACjE,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,IAAI,CAAC;QAEzC,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CACD"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './constants.js';
+export * from './habbo.js';
+export * from './routes/achievements.js';
+export * from './routes/groups.js';
+export * from './routes/lists.js';
+export * from './routes/marketplace.js';
+export * from './routes/ping.js';
+export * from './routes/rooms.js';
+export * from './routes/users.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/{src/index.ts → dist/index.js}

@@ -7,3 +7,4 @@ export * from './routes/marketplace.js';
 export * from './routes/ping.js';
 export * from './routes/rooms.js';
 export * from './routes/users.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/dist/routes/achievements.d.ts

@@ -0,0 +1,52 @@
+import { type FetchResult } from '@skyra/safe-fetch';
+import { BaseAPI, type APIOptions } from './base.js';
+import type { HabboUserId } from './users.js';
+export declare class AchievementsAPI extends BaseAPI {
+    /**
+     * Get all achievements
+     *
+     * @param options - The options for the API call
+     */
+    getAll(options?: APIOptions): Promise<FetchResult<Achievement[]>>;
+    /**
+     * Get the achievements from a specified user ID
+     *
+     * @param id - The ID of the user
+     * @param options - The options for the API call
+     */
+    getByUserId(id: HabboUserId, options?: APIOptions): Promise<FetchResult<UserAchievement[]>>;
+    /**
+     * Get the image URL for an achievement
+     *
+     * @param achievementName - The name of the achievement, retrieved from {@linkcode AchievementData.name}
+     *
+     * @unstable This feature is not documented, use at your own risk
+     */
+    getImageURL(achievementName: string): URL;
+}
+export interface Achievement {
+    achievement: AchievementData;
+    levelRequirements: AchievementRequirements;
+}
+export interface UserAchievement {
+    achievement: AchievementData;
+    level: number;
+    score: number;
+}
+export interface AchievementData {
+    id: number;
+    name: string;
+    creationTime: `${bigint}-${bigint}-${bigint}`;
+    state: AchievementDataState;
+    category: string;
+}
+export declare enum AchievementDataState {
+    Enabled = "ENABLED",
+    Archived = "ARCHIVED",
+    OffSeason = "OFF_SEASON"
+}
+export interface AchievementRequirements {
+    level: number;
+    requiredScore: number;
+}
+//# sourceMappingURL=achievements.d.ts.map

package/dist/routes/achievements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"achievements.d.ts","sourceRoot":"","sources":["../../src/routes/achievements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,qBAAa,eAAgB,SAAQ,OAAO;IAC3C;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC,CAAC;IAKxE;;;;;OAKG;IACI,WAAW,CAAC,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,CAAC;IAKlG;;;;;;OAMG;IACI,WAAW,CAAC,eAAe,EAAE,MAAM,GAAG,GAAG;CAGhD;AAED,MAAM,WAAW,WAAW;IAC3B,WAAW,EAAE,eAAe,CAAC;IAC7B,iBAAiB,EAAE,uBAAuB,CAAC;CAC3C;AAED,MAAM,WAAW,eAAe;IAC/B,WAAW,EAAE,eAAe,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,eAAe;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,GAAG,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;IAC9C,KAAK,EAAE,oBAAoB,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,oBAAoB;IAC/B,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,SAAS,eAAe;CACxB;AAED,MAAM,WAAW,uBAAuB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;CACtB"}

package/dist/routes/achievements.js

@@ -0,0 +1,40 @@
+import { Json } from '@skyra/safe-fetch';
+import { BaseAPI } from './base.js';
+export class AchievementsAPI extends BaseAPI {
+    /**
+     * Get all achievements
+     *
+     * @param options - The options for the API call
+     */
+    getAll(options) {
+        const url = this.formatURL('/api/public/achievements');
+        return Json(this.fetch(url, options));
+    }
+    /**
+     * Get the achievements from a specified user ID
+     *
+     * @param id - The ID of the user
+     * @param options - The options for the API call
+     */
+    getByUserId(id, options) {
+        const url = this.formatURL(`/api/public/achievements/${id}`);
+        return Json(this.fetch(url, options));
+    }
+    /**
+     * Get the image URL for an achievement
+     *
+     * @param achievementName - The name of the achievement, retrieved from {@linkcode AchievementData.name}
+     *
+     * @unstable This feature is not documented, use at your own risk
+     */
+    getImageURL(achievementName) {
+        return new URL(`https://images.habbo.com/c_images/album1584/${achievementName}.png`);
+    }
+}
+export var AchievementDataState;
+(function (AchievementDataState) {
+    AchievementDataState["Enabled"] = "ENABLED";
+    AchievementDataState["Archived"] = "ARCHIVED";
+    AchievementDataState["OffSeason"] = "OFF_SEASON";
+})(AchievementDataState || (AchievementDataState = {}));
+//# sourceMappingURL=achievements.js.map

package/dist/routes/achievements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"achievements.js","sourceRoot":"","sources":["../../src/routes/achievements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAmB,MAAM,WAAW,CAAC;AAGrD,MAAM,OAAO,eAAgB,SAAQ,OAAO;IAC3C;;;;OAIG;IACI,MAAM,CAAC,OAAoB;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACvD,OAAO,IAAI,CAAgB,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,EAAe,EAAE,OAAoB;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAoB,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACI,WAAW,CAAC,eAAuB;QACzC,OAAO,IAAI,GAAG,CAAC,+CAA+C,eAAe,MAAM,CAAC,CAAC;IACtF,CAAC;CACD;AAqBD,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC/B,2CAAmB,CAAA;IACnB,6CAAqB,CAAA;IACrB,gDAAwB,CAAA;AACzB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B"}

package/dist/routes/base.d.ts

@@ -0,0 +1,13 @@
+import { type FetchResult } from '@skyra/safe-fetch';
+export declare abstract class BaseAPI {
+    #private;
+    protected readonly baseURL: string;
+    protected readonly timeout: number | null;
+    constructor(baseURL: string, timeout?: number | null | undefined);
+    protected formatURL(route: string): URL;
+    protected fetch(url: string | URL, options?: APIOptions): Promise<FetchResult<Response>>;
+}
+export interface APIOptions {
+    signal?: AbortSignal | number | null | undefined;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/routes/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/routes/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhE,8BAAsB,OAAO;;IAC5B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACnC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEvB,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAKvE,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG;IAIvC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;CAaxF;AAED,MAAM,WAAW,UAAU;IAC1B,MAAM,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;CACjD"}

package/dist/routes/base.js

@@ -0,0 +1,44 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _BaseAPI_instances, _BaseAPI_getSignalOrDefault;
+import { safeFetch } from '@skyra/safe-fetch';
+export class BaseAPI {
+    constructor(baseURL, timeout) {
+        _BaseAPI_instances.add(this);
+        Object.defineProperty(this, "baseURL", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "timeout", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.baseURL = baseURL;
+        this.timeout = timeout ?? null;
+    }
+    formatURL(route) {
+        return new URL(route, this.baseURL);
+    }
+    fetch(url, options) {
+        return safeFetch(url, { headers: { 'Content-Type': 'application/json' }, signal: __classPrivateFieldGet(this, _BaseAPI_instances, "m", _BaseAPI_getSignalOrDefault).call(this, options) });
+    }
+}
+_BaseAPI_instances = new WeakSet(), _BaseAPI_getSignalOrDefault = function _BaseAPI_getSignalOrDefault(options) {
+    if (typeof options === 'object' && options !== null) {
+        if (typeof options.signal === 'number')
+            return AbortSignal.timeout(options.signal);
+        if (typeof options.signal === 'object' && options.signal !== null)
+            return options.signal;
+    }
+    if (typeof this.timeout === 'number')
+        return AbortSignal.timeout(this.timeout);
+    return null;
+};
+//# sourceMappingURL=base.js.map

package/dist/routes/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/routes/base.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,SAAS,EAAoB,MAAM,mBAAmB,CAAC;AAEhE,MAAM,OAAgB,OAAO;IAI5B,YAAmB,OAAe,EAAE,OAAmC;;QAHpD;;;;;WAAgB;QAChB;;;;;WAAuB;QAGzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,IAAI,CAAC;IAChC,CAAC;IAES,SAAS,CAAC,KAAa;QAChC,OAAO,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAES,KAAK,CAAC,GAAiB,EAAE,OAAoB;QACtD,OAAO,SAAS,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,uBAAA,IAAI,uDAAoB,MAAxB,IAAI,EAAqB,OAAO,CAAC,EAAE,CAAC,CAAC;IACvH,CAAC;CAWD;uGAToB,OAAoB;IACvC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrD,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ;YAAE,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACnF,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI;YAAE,OAAO,OAAO,CAAC,MAAM,CAAC;IAC1F,CAAC;IAED,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ;QAAE,OAAO,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,OAAO,IAAI,CAAC;AACb,CAAC"}

package/dist/routes/groups.d.ts

@@ -0,0 +1,111 @@
+import { type FetchResult } from '@skyra/safe-fetch';
+import { BaseAPI, type APIOptions } from './base.js';
+export declare class GroupsAPI extends BaseAPI {
+    /**
+     * Get the data for a group given its identifier
+     *
+     * @param id - The ID of the group
+     * @param options - The options for the API call
+     */
+    getByUniqueId(id: HabboGroupId, options?: APIOptions): Promise<FetchResult<HabboGroup>>;
+    /**
+     * Get the members from a group given its identifier
+     *
+     * @param id - The ID of the group
+     * @param options - The options for the API call
+     */
+    getGroupMembers(id: HabboGroupId, options?: APIOptions): Promise<FetchResult<HabboGroupMember[]>>;
+    /**
+     * Get the image URL for a badge
+     *
+     * @param badgeCode - The badge's code, retrieved from {@linkcode HabboGroup.badgeCode}
+     *
+     * @unstable This feature is not documented, use at your own risk
+     */
+    getGroupBadgeImageURL(badgeCode: string): URL;
+}
+export type HabboGroupId = `g-hh${string}-${string};`;
+/**
+ * Represents a Habbo group.
+ */
+export interface HabboGroup {
+    /**
+     * The unique identifier of the group.
+     */
+    id: HabboGroupId;
+    /**
+     * The name of the group.
+     */
+    name: string;
+    /**
+     * The description of the group.
+     */
+    description: string;
+    /**
+     * The type of the group.
+     */
+    type: HabboGroupType;
+    /**
+     * The ID of the room associated with the group, or null if no room is associated.
+     */
+    roomId: number | null;
+    /**
+     * The badge code of the group.
+     */
+    badgeCode: string;
+}
+/**
+ * Enum representing the type of a Habbo group.
+ */
+export declare enum HabboGroupType {
+    /**
+     * A normal group (public).
+     */
+    NORMAL = "NORMAL",
+    /**
+     * A favourite (exclusive) group.
+     */
+    FAVOURITE = "EXCLUSIVE",
+    /**
+     * A private (closed) group.
+     */
+    PRIVATE = "CLOSED"
+}
+/**
+ * Represents a member of a Habbo group.
+ */
+export interface HabboGroupMember {
+    /**
+     * Indicates whether the member is online.
+     */
+    online: boolean;
+    /**
+     * The gender of the member.
+     */
+    gender: 'm' | 'f';
+    /**
+     * The motto of the member.
+     */
+    motto: string;
+    /**
+     * The figure of the member in the Habbo world.
+     */
+    habboFigure: string;
+    /**
+     * The date since the member joined the group.
+     */
+    memberSince: string;
+    /**
+     * The unique identifier of the member.
+     */
+    uniqueId: string;
+    /**
+     * The name of the member.
+     */
+    name: string;
+    /**
+     * Indicates whether the member is an admin of the group.
+     */
+    isAdmin: boolean;
+}
+//# sourceMappingURL=groups.d.ts.map

package/dist/routes/groups.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.d.ts","sourceRoot":"","sources":["../../src/routes/groups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAErD,qBAAa,SAAU,SAAQ,OAAO;IACrC;;;;;OAKG;IACI,aAAa,CAAC,EAAE,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAK9F;;;;;OAKG;IACI,eAAe,CAAC,EAAE,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAKxG;;;;;;OAMG;IACI,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG;CAGpD;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,MAAM,IAAI,MAAM,GAAG,CAAA;AAErD;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,EAAE,EAAE,YAAY,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,oBAAY,cAAc;IACzB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,OAAO,WAAW;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CACjB"}

package/dist/routes/groups.js

@@ -0,0 +1,53 @@
+import { Json } from '@skyra/safe-fetch';
+import { BaseAPI } from './base.js';
+export class GroupsAPI extends BaseAPI {
+    /**
+     * Get the data for a group given its identifier
+     *
+     * @param id - The ID of the group
+     * @param options - The options for the API call
+     */
+    getByUniqueId(id, options) {
+        const url = this.formatURL(`/api/public/groups/${id}`);
+        return Json(this.fetch(url, options));
+    }
+    /**
+     * Get the members from a group given its identifier
+     *
+     * @param id - The ID of the group
+     * @param options - The options for the API call
+     */
+    getGroupMembers(id, options) {
+        const url = this.formatURL(`/api/public/groups/${id}/members`);
+        return Json(this.fetch(url, options));
+    }
+    /**
+     * Get the image URL for a badge
+     *
+     * @param badgeCode - The badge's code, retrieved from {@linkcode HabboGroup.badgeCode}
+     *
+     * @unstable This feature is not documented, use at your own risk
+     */
+    getGroupBadgeImageURL(badgeCode) {
+        return this.formatURL(`/habbo-imaging/badge/${badgeCode}`);
+    }
+}
+/**
+ * Enum representing the type of a Habbo group.
+ */
+export var HabboGroupType;
+(function (HabboGroupType) {
+    /**
+     * A normal group (public).
+     */
+    HabboGroupType["NORMAL"] = "NORMAL";
+    /**
+     * A favourite (exclusive) group.
+     */
+    HabboGroupType["FAVOURITE"] = "EXCLUSIVE";
+    /**
+     * A private (closed) group.
+     */
+    HabboGroupType["PRIVATE"] = "CLOSED";
+})(HabboGroupType || (HabboGroupType = {}));
+//# sourceMappingURL=groups.js.map

package/dist/routes/groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../src/routes/groups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAmB,MAAM,WAAW,CAAC;AAErD,MAAM,OAAO,SAAU,SAAQ,OAAO;IACrC;;;;;OAKG;IACI,aAAa,CAAC,EAAgB,EAAE,OAAoB;QAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;QACvD,OAAO,IAAI,CAAa,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,EAAgB,EAAE,OAAoB;QAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE,UAAU,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAqB,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,SAAiB;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;IAC5D,CAAC;CACD;AAuCD;;GAEG;AACH,MAAM,CAAN,IAAY,cAeX;AAfD,WAAY,cAAc;IACzB;;OAEG;IACH,mCAAiB,CAAA;IAEjB;;OAEG;IACH,yCAAuB,CAAA;IAEvB;;OAEG;IACH,oCAAkB,CAAA;AACnB,CAAC,EAfW,cAAc,KAAd,cAAc,QAezB"}

package/dist/routes/lists.d.ts

@@ -0,0 +1,21 @@
+import { type FetchResult } from '@skyra/safe-fetch';
+import { BaseAPI, type APIOptions } from './base.js';
+export declare class ListsAPI extends BaseAPI {
+    #private;
+    /**
+     * Get the hot looks from the hotel
+     *
+     * @param options - The options for the API call
+     */
+    getHotLooks(options: APIOptions): Promise<FetchResult<HabboHotLookList>>;
+}
+export interface HabboHotLookList {
+    url: string;
+    entries: HabboHotLookListItem[];
+}
+export interface HabboHotLookListItem {
+    gender: 'f' | 'm';
+    figure: string;
+    hash: string;
+}
+//# sourceMappingURL=lists.d.ts.map

package/dist/routes/lists.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lists.d.ts","sourceRoot":"","sources":["../../src/routes/lists.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAErD,qBAAa,QAAS,SAAQ,OAAO;;IACpC;;;;OAIG;IACU,WAAW,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;CAoBrF;AAED,MAAM,WAAW,gBAAgB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,oBAAoB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACb"}

package/dist/routes/lists.js

@@ -0,0 +1,38 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ListsAPI_instances, _ListsAPI_parseHotLooksXML;
+import {} from '@skyra/safe-fetch';
+import { BaseAPI } from './base.js';
+export class ListsAPI extends BaseAPI {
+    constructor() {
+        super(...arguments);
+        _ListsAPI_instances.add(this);
+    }
+    /**
+     * Get the hot looks from the hotel
+     *
+     * @param options - The options for the API call
+     */
+    async getHotLooks(options) {
+        const url = this.formatURL('/api/public/lists/hotlooks');
+        const data = await this.fetch(url, options);
+        return data.map(async (result) => __classPrivateFieldGet(this, _ListsAPI_instances, "m", _ListsAPI_parseHotLooksXML).call(this, await result.text())).intoPromise();
+    }
+}
+_ListsAPI_instances = new WeakSet(), _ListsAPI_parseHotLooksXML = function _ListsAPI_parseHotLooksXML(data) {
+    const urlResult = /url="(.*)"/.exec(data);
+    if (urlResult === null)
+        throw new SyntaxError('Could not read hot looks');
+    const url = urlResult[1];
+    const entries = [];
+    for (const result of data.matchAll(/gender="(\w)" figure="(.+)" hash="(.+)"/g)) {
+        entries.push({ gender: result[1], figure: result[2], hash: result[3] });
+    }
+    if (entries.length === 0)
+        throw new SyntaxError('Could not read hot looks');
+    return { url, entries };
+};
+//# sourceMappingURL=lists.js.map

package/dist/routes/lists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lists.js","sourceRoot":"","sources":["../../src/routes/lists.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAoB,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,OAAO,EAAmB,MAAM,WAAW,CAAC;AAErD,MAAM,OAAO,QAAS,SAAQ,OAAO;IAArC;;;IA0BA,CAAC;IAzBA;;;;OAIG;IACI,KAAK,CAAC,WAAW,CAAC,OAAmB;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC;QACzD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,uBAAA,IAAI,uDAAkB,MAAtB,IAAI,EAAmB,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9F,CAAC;CAgBD;sGAdkB,IAAY;IAC7B,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1C,IAAI,SAAS,KAAK,IAAI;QAAE,MAAM,IAAI,WAAW,CAAC,0BAA0B,CAAC,CAAC;IAE1E,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IACzB,MAAM,OAAO,GAAG,EAA4B,CAAC;IAC7C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,0CAA0C,CAAC,EAAE,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAc,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,WAAW,CAAC,0BAA0B,CAAC,CAAC;IAE5E,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC;AACzB,CAAC"}