yolkbot 0.1.0-alpha.4 → 0.1.0-alpha.6

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "yolkbot",
     "description": "create a shell shockers (self) bot in under 10 lines.",
-    "version": "0.1.0-alpha.4",
+    "version": "0.1.0-alpha.6",
     "keywords": [
         "shell shockers",
         "shellshock.io",
@@ -31,18 +31,36 @@
     "exports": {
         "./package.json": "./package.json",
         ".": "./src/index.js",
-        "./api": "./src/api.js",
-        "./bot": "./src/bot.js",
+        "./api": {
+            "import": "./src/api.js",
+            "types": "./src/types/api.d.ts"
+        },
+        "./bot": {
+            "import": "./src/bot.js",
+            "types": "./src/types/bot.d.ts"
+        },
         "./browser": "./build/browser.js",
         "./comm": "./src/comm/index.js",
-        "./matchmaker": "./src/matchmaker.js",
+        "./matchmaker": {
+            "import": "./src/matchmaker.js",
+            "types": "./src/types/matchmaker.d.ts"
+        },
         "./packets": "./src/packet.js",
         "./constants": "./src/constants/index.js",
         "./constants/*": "./src/constants/*.js",
         "./constants/*.js": "./src/constants/*.js",
-        "./dispatch": "./src/dispatches/index.js",
-        "./dispatch/*": "./src/dispatches/*.js",
-        "./dispatch/*.js": "./src/dispatches/*.js"
+        "./dispatch": {
+            "import": "./src/dispatches/index.js",
+            "types": "./src/types/dispatches.d.ts"
+        },
+        "./dispatch/*": {
+            "import": "./src/dispatches/*.js",
+            "types": "./src/types/dispatches/*.d.ts"
+        },
+        "./dispatch/*.js": {
+            "import": "./src/dispatches/*.js",
+            "types": "./src/types/dispatches/*.d.ts"
+        }
     },
     "dependencies": {
         "socks-proxy-agent": "^8.0.5",

package/src/api.js

@@ -1,8 +1,6 @@
 import yolkws from './socket.js';
 
-import { UserAgent } from '#constants';
-
-const firebaseKey = 'AIzaSyDP4SIjKaw6A4c-zvfYxICpbEjn1rRnN50';
+import { FirebaseKey, UserAgent } from '#constants';
 
 const queryServices = async (request, proxy = '', instance = 'shellshock.io') => {
     return new Promise((resolve) => {
@@ -62,7 +60,7 @@ async function loginWithCredentials(email, password, prox = '', instance = 'shel
 
     while (!SUCCESS) {
         try {
-            request = await fetch('https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=' + firebaseKey, {
+            request = await fetch('https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=' + FirebaseKey, {
                 method: 'POST',
                 body: JSON.stringify({
                     email: email,
@@ -108,7 +106,7 @@ async function loginWithCredentials(email, password, prox = '', instance = 'shel
 }
 
 async function loginAnonymously(prox = '', instance = 'shellshock.io') {
-    const request = await fetch('https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=' + firebaseKey, {
+    const request = await fetch('https://identitytoolkit.googleapis.com/v1/accounts:signUp?key=' + FirebaseKey, {
         method: 'POST',
         body: JSON.stringify({ returnSecureToken: true }),
         headers: {

package/src/constants/index.js

@@ -19,6 +19,8 @@ export const CoopStates = {
     unclaimed: 7
 }
 
+export const FirebaseKey = 'AIzaSyDP4SIjKaw6A4c-zvfYxICpbEjn1rRnN50';
+
 export const GameActions = {
     reset: 1,
     pause: 2

package/src/dispatches/index.js

@@ -15,6 +15,7 @@ import SaveLoadoutDispatch from './SaveLoadoutDispatch.js';
 import SpawnDispatch from './SpawnDispatch.js';
 import SwapWeaponDispatch from './SwapWeaponDispatch.js';
 import SwitchTeamDispatch from './SwitchTeamDispatch.js';
+import ThrowGrenadeDispatch from './ThrowGrenadeDispatch.js';
 
 export {
     BootPlayerDispatch,
@@ -33,7 +34,8 @@ export {
     SaveLoadoutDispatch,
     SpawnDispatch,
     SwapWeaponDispatch,
-    SwitchTeamDispatch
+    SwitchTeamDispatch,
+    ThrowGrenadeDispatch
 }
 
 export default {
@@ -53,5 +55,6 @@ export default {
     SaveLoadoutDispatch,
     SpawnDispatch,
     SwapWeaponDispatch,
-    SwitchTeamDispatch
+    SwitchTeamDispatch,
+    ThrowGrenadeDispatch
 }

package/src/types/api.d.ts

@@ -0,0 +1,35 @@
+import { FirebaseKey, UserAgent } from '../constants/index.js';
+
+declare module './socket.js' {
+    export default class yolkws {
+        constructor(url: string, proxy: string);
+        onopen: () => void;
+        onmessage: (event: { data: string }) => void;
+        onerror: () => void;
+        onclose: () => void;
+        send(data: string): void;
+        close(): void;
+    }
+}
+
+export interface QueryRequest {
+    cmd: string;
+    firebaseToken?: string;
+}
+
+export interface QueryResponse {
+    id?: number;
+    firebaseId?: string;
+    sessionId?: string;
+    session?: number;
+    kills?: number;
+    deaths?: number;
+    currentBalance?: number;
+    [key: string]: any;
+}
+
+export function queryServices(request: QueryRequest, proxy?: string, instance?: string): Promise<QueryResponse | string>;
+
+export function loginWithCredentials(email: string, password: string, prox?: string, instance?: string): Promise<QueryResponse | string>;
+
+export function loginAnonymously(prox?: string, instance?: string): Promise<QueryResponse | string>;

package/src/types/bot/GamePlayer.d.ts

@@ -0,0 +1,83 @@
+import { GunList } from '#constants';
+import { Cluck9mm } from '../constants/guns.js';
+
+export interface Position {
+    x: number;
+    y: number;
+    z: number;
+}
+
+export interface View {
+    yaw: number;
+    pitch: number;
+}
+
+export interface Character {
+    eggColor: string;
+    primaryGun: any;
+    secondaryGun: any;
+    stamp: any;
+    hat: any;
+    grenade: any;
+    melee: any;
+}
+
+export interface Buffer {
+    [key: number]: any;
+}
+
+export interface PlayerData {
+    name_: string;
+    uniqueId_: string;
+    playing_: boolean;
+    social_: string;
+    hideBadge_: boolean;
+    x_: number;
+    y_: number;
+    z_: number;
+    yaw_: number;
+    pitch_: number;
+    shellColor_: string;
+    primaryWeaponItem_: any;
+    secondaryWeaponItem_: any;
+    stampItem_: any;
+    hatItem_: any;
+    grenadeItem_: any;
+    meleeItem_: any;
+    weaponIdx_: number;
+}
+
+export class GamePlayer {
+    id: string;
+    team: string;
+    data: PlayerData;
+    name: string;
+    uniqueId: string;
+    playing: boolean;
+    social: any;
+    showBadge: boolean;
+    position: Position;
+    jumping: boolean;
+    climbing: boolean;
+    view: View;
+    character: Character;
+    activeGun: number;
+    selectedGun: number;
+    weapons: any[];
+    grenades: number;
+    buffer: Buffer;
+    kills: number;
+    hp: number;
+    hpShield: number;
+    streakRewards: any[];
+    randomSeed: number;
+    serverStateIdx: number;
+
+    constructor(id: string, team: string, playerData: PlayerData);
+
+    dispatch(): void;
+    join(): void;
+    update(): void;
+}
+
+export default GamePlayer;

package/src/types/bot.d.ts

@@ -0,0 +1,152 @@
+import { CommCode } from '../comm/Codes.js';
+import { GamePlayer } from '../bot/GamePlayer.js';
+import { Matchmaker } from '../matchmaker.js';
+import { yolkws } from '../socket.js';
+import { NodeList } from '../pathing/mapnode.js';
+import { Maps } from '../constants/maps.js';
+
+export interface BotParams {
+    name?: string;
+    proxy?: string;
+    doUpdate?: boolean;
+    updateInterval?: number;
+    doPing?: boolean;
+    pingInterval?: number;
+    doPathing?: boolean;
+    instance?: string;
+}
+
+export interface Account {
+    firebaseId: string;
+    sessionId: string;
+    session: string;
+    loadout: {
+        hatId: number | null;
+        meleeId: number;
+        stampId: number | null;
+        classIdx: number;
+        colorIdx: number;
+        grenadeId: number;
+        primaryId: number[];
+        secondaryId: number[];
+        stampPositionX: number;
+        stampPositionY: number;
+    };
+    ownedItemIds: number[];
+    vip: boolean;
+    accountAge: number;
+    emailVerified: boolean;
+    eggBalance: number;
+    rawLoginData: any;
+}
+
+export interface GameOptions {
+    gravity: number;
+    damage: number;
+    healthRegen: number;
+    locked: boolean;
+    noTeamChange: boolean;
+    noTeamShuffle: boolean;
+    weaponsDisabled: boolean[];
+    mustUseSecondary: boolean;
+}
+
+export interface Game {
+    raw: any;
+    code: string;
+    gameModeId: number;
+    gameMode: string;
+    mapIdx: number;
+    map: {
+        filename: string;
+        hash: string;
+        name: string;
+        modes: {
+            FFA: boolean;
+            Teams: boolean;
+            Spatula: boolean;
+            King: boolean;
+        };
+        availability: string;
+        numPlayers: string;
+        raw: any;
+        nodes: any;
+    };
+    playerLimit: number;
+    isGameOwner: boolean;
+    isPrivate: boolean;
+    options: GameOptions;
+    collectables: any[][];
+    teamScore: number[];
+    spatula: {
+        coords: { x: number; y: number; z: number };
+        controlledBy: number;
+        controlledByTeam: number;
+    };
+    stage: number;
+    activeZone: number;
+    capturing: number;
+    captureProgress: number;
+    numCapturing: number;
+    stageName: string;
+    capturePercent: number;
+}
+
+export interface Pathing {
+    nodeList: NodeList | null;
+    followingPath: boolean;
+    activePath: any;
+    activeNode: any;
+    activeNodeIdx: number;
+}
+
+export interface BotState {
+    loggedIn: boolean;
+    gameFound: boolean;
+    reloading: boolean;
+    swappingGun: boolean;
+    usingMelee: boolean;
+    shotsFired: number;
+    joinedGame?: boolean;
+}
+
+export class Bot {
+    proxy: string;
+    name: string;
+    autoPing: boolean;
+    autoUpdate: boolean;
+    disablePathing: boolean;
+    pingInterval: number;
+    updateInterval: number;
+    instance: string;
+    state: BotState;
+    players: Record<string, GamePlayer>;
+    me: GamePlayer;
+    game: Game;
+    account: Account;
+    gameSocket: yolkws | null;
+    ping: number;
+    lastPingTime: number;
+    lastDeathTime: number;
+    lastChatTime: number;
+    lastUpdateTime: number;
+    nUpdates: number;
+    controlKeys: number;
+    initTime: number;
+    pathing: Pathing;
+    matchmaker: Matchmaker | null;
+
+    constructor(params?: BotParams);
+
+    login(email: string, pass: string): Promise<Account | false>;
+    dispatch(disp: any): void;
+    drain(): void;
+    initMatchmaker(): Promise<boolean>;
+    createPrivateGame(opts: { region: string; mode: string; map: string }): Promise<any>;
+    join(data: string | any): Promise<void>;
+    update(): void;
+    on(event: string, cb: Function): void;
+    onAny(cb: Function): void;
+}
+
+export default Bot;

package/src/types/dispatches/BootPlayerDispatch.d.ts

@@ -0,0 +1,10 @@
+export declare class BootPlayerDispatch {
+    uniqueId: string;
+
+    constructor(uniqueId: string);
+
+    check(bot: any): boolean;
+    execute(bot: any): void;
+}
+
+export default BootPlayerDispatch;

package/src/types/dispatches/ChatDispatch.d.ts

@@ -0,0 +1,10 @@
+import packet from '#packet';
+
+export declare class ChatDispatch {
+    constructor(msg: string, noLimit?: boolean);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ChatDispatch;

package/src/types/dispatches/FireDispatch.d.ts

@@ -0,0 +1,8 @@
+export declare class FireDispatch {
+    constructor(amount: number);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default FireDispatch;

package/src/types/dispatches/GameOptionsDispatch.d.ts

@@ -0,0 +1,8 @@
+import packet from '#packet';
+
+export declare class GameOptionsDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default GameOptionsDispatch;

package/src/types/dispatches/GoToPlayerDispatch.d.ts

@@ -0,0 +1,10 @@
+import AStar from '../pathing/astar.js';
+
+export declare class GoToPlayerDispatch {
+    constructor(target: GamePlayer);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default GoToPlayerDispatch;

package/src/types/dispatches/GoToSpatulaDispatch.d.ts

@@ -0,0 +1,8 @@
+import AStar from '../pathing/astar.js';
+
+export class GoToSpatulaDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default GoToSpatulaDispatch;

package/src/types/dispatches/LookAtDispatch.d.ts

@@ -0,0 +1,14 @@
+import Bot from '../bot';
+
+declare class LookAtDispatch {
+    idOrName: number | string;
+    id?: number;
+    name?: string;
+
+    constructor(idOrName: number | string);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default LookAtDispatch;

package/src/types/dispatches/LookAtPosDispatch.d.ts

@@ -0,0 +1,17 @@
+type Position = {
+    x: number;
+    y: number;
+    z: number;
+}
+
+export declare class LookAtPosDispatch {
+    idOrName: any;
+    pos: Position;
+
+    constructor(pos: Position);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default LookAtPosDispatch;

package/src/types/dispatches/MeleeDispatch.d.ts

@@ -0,0 +1,6 @@
+export class MeleeDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default MeleeDispatch;

package/src/types/dispatches/MovementDispatch.d.ts

@@ -0,0 +1,10 @@
+export class MovementDispatch {
+    controlKeys: number;
+
+    constructor(controlKeys: number | number[]);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default MovementDispatch;

package/src/types/dispatches/PauseDispatch.d.ts

@@ -0,0 +1,6 @@
+export class PauseDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default PauseDispatch;

package/src/types/dispatches/ReloadDispatch.d.ts

@@ -0,0 +1,6 @@
+export class ReloadDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ReloadDispatch;

package/src/types/dispatches/ReportPlayerDispatch.d.ts

@@ -0,0 +1,13 @@
+export class ReportPlayerDispatch {
+    id?: number;
+    name?: string;
+    reasons: boolean[];
+    reasonInt: number;
+
+    constructor(idOrName: number | string, reasons?: { cheating?: boolean; harassment?: boolean; offensive?: boolean; other?: boolean });
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ReportPlayerDispatch;

package/src/types/dispatches/SaveLoadoutDispatch.d.ts

@@ -0,0 +1,32 @@
+type Changes = {
+    classIdx?: number;
+    hatId?: number;
+    stampId?: number;
+    grenadeId?: number;
+    meleeId?: number;
+    colorIdx?: number;
+    primaryId?: number[];
+    secondaryId?: number[];
+}
+
+type Opts = {
+    gunId?: number;
+    hatId?: number;
+    stampId?: number;
+    grenadeId?: number;
+    meleeId?: number;
+    eggColor?: number;
+    primaryIds?: number[];
+    secondaryIds?: number[];
+}
+
+export class SaveLoadoutDispatch {
+    changes: Changes;
+
+    constructor(opts: Opts);
+
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SaveLoadoutDispatch;

package/src/types/dispatches/SpawnDispatch.d.ts

@@ -0,0 +1,6 @@
+export class SpawnDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SpawnDispatch;

package/src/types/dispatches/SwapWeaponDispatch.d.ts

@@ -0,0 +1,6 @@
+export class SwapWeaponDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SwapWeaponDispatch;

package/src/types/dispatches/SwitchTeamDispatch.d.ts

@@ -0,0 +1,6 @@
+export class SwitchTeamDispatch {
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default SwitchTeamDispatch;

package/src/types/dispatches/ThrowGrenadeDispatch.d.ts

@@ -0,0 +1,7 @@
+export class ThrowGrenadeDispatch {
+    constructor(power?: number);
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
+}
+
+export default ThrowGrenadeDispatch;