@shaunlwm/pickle.ts 1.11.0 → 1.12.1

package/README.md

@@ -2,7 +2,7 @@
 
 Type-safe client library for Club Penguin Private Servers.
 
-Built with TypeScript, Socket.IO, and msgpack. Supports CPJourney, CPLegacy, NewCP, and PenguinOrigins through an adapter pattern.
+Built with TypeScript, Socket.IO, and msgpack. Supports CPJourney, CPLegacy, CPPS.lol, NewCP, and PenguinOrigins through an adapter pattern.
 
 ## Install
 
@@ -44,7 +44,7 @@ Creates a new client instance.
 
 | Param | Type | Description |
 |---|---|---|
-| `server` | `"CPJourney" \| "CPLegacy" \| "NewCP" \| "PenguinOrigins"` | CPPS server identifier (strongly typed) |
+| `server` | `"CPJourney" \| "CPLegacy" \| "CPPSlol" \| "NewCP" \| "PenguinOrigins"` | CPPS server identifier (strongly typed) |
 | `options.debug` | `boolean \| LogFn` | Enable debug logging. Pass `true` for console.log, or a custom function |
 | `options.connectionProfile` | `"chrome" \| "node" \| ConnectionProfile` | Controls HTTP/WebSocket headers. Defaults to browser-like Chrome headers; use `"node"` to preserve Node defaults |
 
@@ -84,7 +84,8 @@ const servers = await client.login({
   timeoutMs: 20_000,
   signal: abortController.signal,
 })
-// servers: ServerInfo[] = [{ name: string, population: number }]
+// servers: ServerInfo[] = [{ name: string, population: number, users?: number }]
+// CPPS.lol: population is browser bars; users is the exact penguin count.
 ```
 
 Also supports token-based login:
@@ -223,12 +224,14 @@ client.disconnect()
 
 All events are fully typed via `ServerMessages`.
 
-`ServerMessages` remains the compatibility aggregate. CPJourney-specific wire
-contracts are also exported separately as `CpjourneyClientMessages` and
-`CpjourneyServerMessages`; unsupported methods throw or reject with a
-non-retryable `ClientOperationError` whose category is
-`unsupported_operation`. Shared actions should be normalized by each adapter
-rather than assuming identical wire payloads.
+`ServerMessages` remains the compatibility aggregate. Server-specific wire
+contracts are also exported separately as `CpjourneyClientMessages`,
+`CpjourneyServerMessages`, `CppslolClientMessages`, and
+`CppslolServerMessages`. CPPS.lol-only operations are available through
+`client.cppslol`; unsupported methods throw or reject with a non-retryable
+`ClientOperationError` whose category is `unsupported_operation`. Shared
+actions should be normalized by each adapter rather than assuming identical
+wire payloads.
 
 ```typescript
 client.on("send_message", ({ id, message }) => {
@@ -303,7 +306,7 @@ import type {
   PlayerSettings,   // game settings
   Buddy,            // buddy list entry
   Mascot,           // mascot data
-  ServerInfo,       // server name + population
+  ServerInfo,       // server name + population; CPPS.lol also includes users
   LoginOptions,     // username + password login
   TokenLoginOptions,// username + token login
   LoginResult,      // login response (servers, key, username)

package/dist/index.d.ts

@@ -25,6 +25,8 @@ type NormalizedConnectionProfile = {
 type ServerInfo = {
     name: string;
     population: number;
+    /** CPPS.lol only: exact number of penguins online. */
+    users?: number;
 };
 type LoginOptions = {
     username: string;
@@ -616,6 +618,53 @@ declare class CplegacyAdapter extends BaseAdapter {
     protected createSocket(serverName: string): Socket;
 }
 
+declare class CppslolAdapter extends BaseAdapter {
+    readonly id = "CPPS.lol";
+    private signer;
+    private sessionToken;
+    login(options: LoginOptions | TokenLoginOptions, operationOptions?: ClientOperationOptions): Promise<LoginResult>;
+    connect(serverName: string, loginResult: LoginResult, options?: ConnectOptions): Promise<Socket>;
+    send(action: string, args: Record<string, unknown>): void;
+    disconnect(): void;
+    normalizeUser(raw: Record<string, unknown>): RoomUser;
+    normalizePlayer(raw: Record<string, unknown>): PlayerData;
+    sendMessage(message: string): void;
+    sendEmote(emote: number): void;
+    sendSafe(safe: number): void;
+    walk(x: number, y: number): void;
+    sendFrame(frame: number, set?: boolean): void;
+    snowball(x: number, y: number): void;
+    joinRoom(room: number, x?: number, y?: number): void;
+    addItem(item: number): void;
+    private updatePlayer;
+    equipColor(item: number): void;
+    equipHead(item: number): void;
+    equipFace(item: number): void;
+    equipNeck(item: number): void;
+    equipBody(item: number): void;
+    equipHand(item: number): void;
+    equipFeet(item: number): void;
+    equipFlag(item: number): void;
+    equipPhoto(item: number): void;
+    getIglooOpen(igloo: number): void;
+    joinIgloo(igloo: number, x?: number, y?: number): void;
+    updateIglooFurniture(furniture: IglooFurniturePlacement[]): void;
+    openIglooRaw(): void;
+    sendPackedEmote(pack: number, emote: number): void;
+    updateLayeredPlayer(item: number): void;
+    acceptMature(): void;
+    removeInventory(item: number): void;
+    getSnowflakeState(): void;
+    getPets(userId: number): void;
+    getIglooContest(): void;
+    getIglooLikesFor(iglooId: number): void;
+    likeIglooById(iglooId: number): void;
+    sendMail(recipient: number, postcardId: number): void;
+    marryRequest(id: number): void;
+    leaveWaddle(): void;
+    protected createSocket(path: string): Socket;
+}
+
 declare class NewcpAdapter extends BaseAdapter {
     readonly id = "NewCP";
     private encryptor;
@@ -691,6 +740,7 @@ declare class PenguinoriginsAdapter extends BaseAdapter {
 }
 
 declare const ADAPTERS: {
+    readonly CPPSlol: typeof CppslolAdapter;
     readonly CPJourney: typeof CpjourneyAdapter;
     readonly CPLegacy: typeof CplegacyAdapter;
     readonly NewCP: typeof NewcpAdapter;
@@ -716,10 +766,11 @@ type ClientMessages = {
         y?: number;
     };
     add_item: {
-        item: number;
+        item: number | string;
     };
     send_emote: {
         emote: number;
+        pack?: number;
     };
     send_safe: {
         safe: number;
@@ -772,7 +823,9 @@ type ClientMessages = {
         userId: number;
         isBackyard?: boolean;
     };
-    get_igloo_likes: Record<string, never>;
+    get_igloo_likes: {
+        iglooId?: number;
+    };
     join_igloo: {
         igloo: number;
         x?: number;
@@ -866,7 +919,9 @@ type ClientMessages = {
     };
     open_igloo: Record<string, never>;
     close_igloo_bounds: Record<string, never>;
-    like_igloo: Record<string, never>;
+    like_igloo: {
+        iglooId?: number;
+    };
     igloo_editor_open: Record<string, never>;
     igloo_editor_closed: Record<string, never>;
     tower_init: Record<string, never>;
@@ -895,6 +950,24 @@ type ClientMessages = {
     join_waddle: {
         waddle: number;
     };
+    /** CPPS.lol-only packets. */
+    leave_waddle: Record<string, never>;
+    remove_inventory: {
+        item: number;
+    };
+    get_snowflake_state: Record<string, never>;
+    accept_mature: Record<string, never>;
+    get_pets: {
+        userId: number;
+    };
+    get_igloo_contest: Record<string, never>;
+    send_mail: {
+        recipient: number;
+        postcardId: number;
+    };
+    marry_request: {
+        id: number;
+    };
 };
 type ServerMessages = {
     login: {
@@ -939,6 +1012,7 @@ type ServerMessages = {
     send_emote: {
         id: number;
         emote: number;
+        pack?: number;
     };
     join_game_room: {
         game: number;
@@ -1030,8 +1104,10 @@ type ServerMessages = {
         id: number;
     };
     add_item: {
-        item: number;
+        item: number | string;
         coins: number;
+        name?: string;
+        slot?: string;
     };
     get_postcards: {
         postcards: Postcard[];
@@ -1258,17 +1334,46 @@ type ServerMessages = {
         uuid: string[];
         message: string;
     };
+    /** CPPS.lol-only events. */
+    remove_inventory: {
+        id: number | string;
+    };
+    snowflake_state: {
+        windowOpen: boolean;
+        lifetimeMs: number;
+        type: string | number | null;
+    };
+    get_pets: {
+        userId?: number;
+        pets: Puffle[];
+    };
+    igloo_contest: {
+        active: boolean;
+    };
+    igloo_likes: {
+        iglooId: number;
+        likes: number;
+        liked: boolean;
+        created?: boolean | string;
+    };
+    marry_request: {
+        id: number;
+    };
 };
+/** CPPS.lol-only commands captured from its signed Socket.IO protocol. */
+type CppslolClientMessages = Pick<ClientMessages, "leave_waddle" | "remove_inventory" | "get_snowflake_state" | "accept_mature" | "get_pets" | "get_igloo_contest" | "send_mail" | "marry_request">;
+/** CPPS.lol-only events captured from its signed Socket.IO protocol. */
+type CppslolServerMessages = Pick<ServerMessages, "remove_inventory" | "snowflake_state" | "get_pets" | "igloo_contest" | "igloo_likes" | "marry_request">;
 /** CPJourney-only commands captured from its Socket.IO protocol. */
 type CpjourneyClientMessages = Pick<ClientMessages, "get_puffles" | "adopt_puffle" | "check_puffle_sprite" | "get_all_puffles" | "get_wellbeing" | "puffle_play" | "update_puffle_rest" | "puffle_buy_item" | "walk_puffle" | "backyard_supplies" | "buddy_find" | "get_store_music" | "add_music" | "get_igloostore_items" | "add_furniture" | "update_music" | "update_furniture" | "update_furniture_auto" | "update_igloo" | "open_igloo" | "close_igloo_bounds" | "like_igloo" | "igloo_editor_open" | "igloo_editor_closed" | "tower_init">;
 /** CPJourney-only events captured from its Socket.IO protocol. */
 type CpjourneyServerMessages = Pick<ServerMessages, "game_over" | "get_postcards" | "join_igloo" | "get_puffles" | "adopt_puffle" | "get_all_puffles" | "get_wellbeing" | "get_walking_puffle" | "update_wellbeing" | "puffle_levelup" | "puffle_popup" | "buy_puffle_item" | "walk_puffle" | "backyard_supplies" | "buddy_find" | "receive_postcard" | "get_store_music" | "add_music" | "get_igloostore_items" | "add_furniture" | "update_music" | "igloo_open_status" | "igloo_bounds_status" | "igloo_liked">;
 
-type RequestFn = <K extends keyof ServerMessages>(event: K, send: () => void, options?: ClientOperationOptions, matches?: (args: ServerMessages[K]) => boolean) => Promise<ServerMessages[K]>;
+type RequestFn$1 = <K extends keyof ServerMessages>(event: K, send: () => void, options?: ClientOperationOptions, matches?: (args: ServerMessages[K]) => boolean) => Promise<ServerMessages[K]>;
 declare class CardJitsu {
     private adapter;
     private request;
-    constructor(adapter: BaseAdapter, request: RequestFn);
+    constructor(adapter: BaseAdapter, request: RequestFn$1);
     /** Fetch ninja rank, progress, and card deck. Resolves with ninja data. */
     getNinja(options?: ClientOperationOptions): Promise<ServerMessages["get_ninja"]>;
     /** Fetch state of all Dojo mats. Resolves with mat state. */
@@ -1287,6 +1392,32 @@ declare class CardJitsu {
     loadAnimation(animation: string): void;
 }
 
+type RequestFn = <K extends keyof ServerMessages>(event: K, send: () => void, options?: ClientOperationOptions, matches?: (args: ServerMessages[K]) => boolean) => Promise<ServerMessages[K]>;
+/** Operations implemented only by CPPS.lol's captured protocol. */
+declare class Cppslol {
+    private readonly baseAdapter;
+    private readonly request;
+    constructor(baseAdapter: BaseAdapter, request: RequestFn);
+    private get adapter();
+    /** Send an emote from a CPPS.lol emote pack. */
+    sendPackedEmote(pack: number, emote: number): void;
+    /** Equip an item in CPPS.lol's additional appearance layer. */
+    updateLayeredPlayer(item: number): void;
+    /** Acknowledge the mature-server notice for the current session. */
+    acceptMature(): void;
+    removeInventory(item: number, options?: ClientOperationOptions): Promise<ServerMessages["remove_inventory"]>;
+    getSnowflakeState(options?: ClientOperationOptions): Promise<ServerMessages["snowflake_state"]>;
+    getPets(userId: number, options?: ClientOperationOptions): Promise<ServerMessages["get_pets"]>;
+    getIglooContest(options?: ClientOperationOptions): Promise<ServerMessages["igloo_contest"]>;
+    getIglooLikes(iglooId: number, options?: ClientOperationOptions): Promise<ServerMessages["igloo_likes"]>;
+    likeIgloo(iglooId: number, options?: ClientOperationOptions): Promise<ServerMessages["igloo_likes"]>;
+    /** CPPS.lol does not acknowledge this action with a dedicated response. */
+    openIgloo(): void;
+    sendMail(recipient: number, postcardId: number): void;
+    marryRequest(id: number): void;
+    leaveWaddle(): void;
+}
+
 type ServerMessageHandler<K extends keyof ServerMessages> = (args: ServerMessages[K]) => void;
 type LogFn = (message: string, ...args: unknown[]) => void;
 type ClientOptions = {
@@ -1302,6 +1433,7 @@ declare class Client extends EventEmitter {
     private loginResult;
     private log;
     private _cardJitsu;
+    private _cppslol;
     private intentionalDisconnect;
     private disconnectNotified;
     private connectionFailure;
@@ -1312,6 +1444,7 @@ declare class Client extends EventEmitter {
     get loginMessage(): string | null;
     get loginStatus(): "active" | "banned";
     get cardJitsu(): CardJitsu;
+    get cppslol(): Cppslol;
     constructor(server: AdapterName, options?: ClientOptions);
     login(options: LoginOptions | TokenLoginOptions, operationOptions?: ClientOperationOptions): Promise<ServerInfo[]>;
     connect(serverName: string, options?: ConnectOptions): Promise<void>;
@@ -1403,4 +1536,4 @@ declare class Client extends EventEmitter {
     private handleMessage;
 }
 
-export { type AdapterName, BaseAdapter, type Buddy, CardJitsu, Client, type ClientConnectionTimeouts, type ClientDisconnectInfo, type ClientLifecyclePhase, type ClientLifecycleUpdate, type ClientMessages, ClientOperationError, type ClientOperationErrorCategory, type ClientOperationErrorOptions, type ClientOperationOptions, type ClientOptions, type ConnectOptions, type ConnectionProfile, type ConnectionProfileInput, type ConnectionProfilePreset, type CpjourneyClientMessages, type CpjourneyServerMessages, DEFAULT_CLIENT_CONNECTION_TIMEOUTS, type FurnitureStoreItem, type GameCard, type GamePlayer, type IglooFurniturePlacement, type IglooStoreItem, type LogFn, type LoginOptions, type LoginResult, type Mascot, type MatState, type NinjaCard, type NinjaData, type NinjaProgress, type PlayerAppearance, type PlayerData, type PlayerSettings, type Postcard, type Puffle, type PuffleWellbeing, type QueueUpdate, type RevealedCard, type RoomUser, type RoundResult, type ServerInfo, type ServerMessages, type TokenLoginOptions, sanitizeClientErrorMessage };
+export { type AdapterName, BaseAdapter, type Buddy, CardJitsu, Client, type ClientConnectionTimeouts, type ClientDisconnectInfo, type ClientLifecyclePhase, type ClientLifecycleUpdate, type ClientMessages, ClientOperationError, type ClientOperationErrorCategory, type ClientOperationErrorOptions, type ClientOperationOptions, type ClientOptions, type ConnectOptions, type ConnectionProfile, type ConnectionProfileInput, type ConnectionProfilePreset, type CpjourneyClientMessages, type CpjourneyServerMessages, Cppslol, type CppslolClientMessages, type CppslolServerMessages, DEFAULT_CLIENT_CONNECTION_TIMEOUTS, type FurnitureStoreItem, type GameCard, type GamePlayer, type IglooFurniturePlacement, type IglooStoreItem, type LogFn, type LoginOptions, type LoginResult, type Mascot, type MatState, type NinjaCard, type NinjaData, type NinjaProgress, type PlayerAppearance, type PlayerData, type PlayerSettings, type Postcard, type Puffle, type PuffleWellbeing, type QueueUpdate, type RevealedCard, type RoomUser, type RoundResult, type ServerInfo, type ServerMessages, type TokenLoginOptions, sanitizeClientErrorMessage };