node-leek 1.0.2 → 1.0.3

package/README.md

@@ -1,68 +1,82 @@
 # 🥬 NodeLeek
-Simple NodeJs client for LeekWars.
-Uses OpenAPI to autogenerate API client (specifications are handwritten as no official uptodate spec exists).
+Simple NodeJs client for LeekWars. Can update scripts, buy items and start fight.  
+NodeLeek support the WebSocket connection, so it can read notification and start boss fight.
+```typescript
+const nodeLeek = new NodeLeekClient("Account", "Password");
+await nodeLeek.login();
+// Do stuff
+await nodeLeek.close()
+```
+> 💚 NodeLeek connected !  
+> 🤠 PorteventRemote (5000 habs)  
+> 🥬 PorteAutomatique lvl.1 - 100 talents - ⚠️ 50 capitals to spend
+
+Fight in garden :
+```typescript
+let myLeek: PublicLeek = nodeLeek.leeks[0];
+let opponent: Opponent;
+let fightId: number;
 
+[opponent, fightId] = await nodeLeek.startRandomSoloFight(myLeek.id);
+
+console.log("Fighting : ", opponent.name);
+console.log("Fight result : ", await nodeLeek.getCompleteFight(fightId));
+```
+
+Fight bosses :
 ```typescript
-var nodeLeek = new NodeLeekClient();
-nodeLeek.login("YOUR_ACCOUNT", "YOUR_PASSWORD").then(() =>
-    nodeLeek.gardenGetGet().then(garden => console.log("I have " + garden.fights + " fights"))
-    nodeLeek.fetchFile(nodeLeek.farmer.files['myreworkediaagainagain2bis/new/mynewia'].id, 0).then(file => console.log("My AI code is : \n" + file.code))
-);
+const roomId = await nodeLeek.createRoom(1); // 1 for Nasu Samurai, 2 for Fennel King, 3 for Evil Pumpkin
+// use await nodeLeek.joinRoom(roomId); to join the room with another account
+await nodeLeek.startRoomFight();
 ```
 
-> ❗ Work in progress, we recommend to set `-- --readonly` on first uses to ensure no damages are done
+## Get started
+Install NodeLeek from [npm](https://www.npmjs.com/package/node-leek) :
+```shell
+npm install node-leek
+```
 
+## Routes supported
+Uses OpenAPI to autogenerate API client (specifications are handwritten as no official uptodate spec exists).
+Check the [OpenAPI](./src/openapi/leekwars-api.json) specification.  
+So far only the most used route are supported, further support will come.
 
-Done :
-- /farmer 
+- /farmer
   - /login : partially, some part of the response (such as chat message) aren't done yet
 - /garden
-  - /start-solo-fight
-  - /get-leek-opponnents/{leekId}
   - /get
+  - /get-leek-opponnents/{leekId}
+  - /get-farmer-opponnents/
+  - /start-solo-fight
+  - /start-farmer-fight
+- /fight
+  - /get/{fightId}
+- /leek
+  - /spend-capital
+  - /get/{leekId}
+- /marker
+  - /buy-habs-quantity
 - /ai-folder
   - /new-name
   - /delete
 - /ai
-  - /save 
+  - /save
   - /new-name
   - /delete
   - /sync
 
-Planning to do :
-- ai rename
-- ai bin clear
-- other fight type
-- assign IA to leek
-
-Considering :
-- stats assignment, equipment & chip assignment
-- dashboard
-
-## How to install
-> This project works with NodeJS. You must install it beforehand.  
-
-Clone the repository and install the dependencies
-```shell
-git clone https://github.com/Portevent/node-leek
-npm update
-npm install
-```
-
 # 🔄 LeekSync (WIP)
 LeekSync allows you to clone your LeekWars file on your local computer and sync them with a file watcher.  
 Open your favorite local IDE, edit some files and they get upload to LeekWars seamlessly.  
 If you happen to change your file locally while LeekSync is not running, or you edited file through LeekWars editor, LeekSync will ask you which source to use and update the other to be on the same page
 
 ### Download your leekscripts
+We recommend using `const nodeLeek = new NodeLeekClient("Account", "Password", true);` to start NodeLeek in read only mode.
+This will ensure no modification are done to your leekwars account. Once you downloaded your scripts and have a secured backup, you can remove this readonly flag.
 ```typescript
-npm run leeksync -- --readonly
+  nodeLeek.syncWith("../my-files/", false, "leekwars")
 ```
 
-> 💚 NodeLeek connected !  
-> 🤠 PorteventRemote (5000 habs)  
-> 🥬 PorteAutomatique lvl.1 - 100 talents - ⚠️ 50 capitals to spend  
-> LeekSync is ready !
 
 You should see your own code in leekscripts folder. Here is an example :
 
@@ -70,40 +84,24 @@ You should see your own code in leekscripts folder. Here is an example :
 ├── DamageCalculation  
 │   └── NaiveDamageCalculation.leek  
 ├── MyFirstIa.leek  
-└── Test.leek  
+└── Test.leek
 
 ### Upload your leekscripts
 **We strongly recommend to save your code, copying it or upload it to a Git repository**  
 **Uploading an empty folder will result in your leekwars account being just an empty folder.  
 Use LeekSync with care, and have a backup**
 
-First, we need to remove the ` --readonly` option to actually edit our leekwars account.  
-You can use the `--watch` option to activate the watcher. It will listen to any modification done, and will automaticly push them to Leekwars.
+First, we need to remove the `readonly` option to actually edit our leekwars account.  
+You can use the `watch` option to activate the watcher. It will listen to any modification done, and will automaticly push them to Leekwars.
 
 ```typescript
-npm run leeksync -- --watch --readonly
+  nodeLeek.syncWith("../my-files/", true, "leekwars")
 ```
 
 Edit your file and refresh Leekwars to see the updated files :
 
 ![Output](./doc/code_example.png)
 
-Additional information :
-- The first `--` are mandatory to use option, and tell `npm` the options coming next are not npm options but leeksync options
-- You can use `--path my_folder` to specify your code folder
-- You can use `-w` as a shorthand of `--watch`, and ` -r` for `--watch`
-- You can use `--choice <something>` to automaticly choose how to resolve out of sync situation (for instance `-c local` to always keep local file and push missing modification to leekwars)
-- LeekSync store your LeekWars timestamp and local timestamp in cache file, so that the next time you launch Leeksync, it won't reimport every files.
-
-### Supported operation
-Watcher :
-- LeekWars : not watching edit and don't plan to yet. Edit made on LeekWars while LeekSync is up won't be recorded
-- Local files : will watch for new file, file change, and file or folder deletion.
-    - Planning to add rename support
-
 
-## Road map
-Next feature will be adding auto fighter, and auto logger.
-I have other ideas but I want to focus on these two points first.
-I want to clean up a bit the codebase, so I might rework a lot of stuff after finishing the auto logger.
+## Help needed
 > ❗ Uses outdated package https://www.npmjs.com/package/request because I couldn't make other OpenAPI codegen variants work with cookie authentification. This issue must be resolved to ensure a cleaner code

package/dist/credentials/credentials-manager.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CredentialsManager = exports.LeekwarsCredentials = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
-const node_leek_client_js_1 = __importDefault(require("../node-leek-client/node-leek-client.js"));
+const node_leek_client_1 = require("../node-leek-client/node-leek-client");
 class LeekwarsCredentials {
     username = "";
     password = "";
@@ -33,7 +33,7 @@ class CredentialsManager {
             return null;
         }
         if (this.clients[index] == null) {
-            this.clients[index] = new node_leek_client_js_1.default(this.credentials[index].username, this.credentials[index].password, readonly);
+            this.clients[index] = new node_leek_client_1.NodeLeekClient(this.credentials[index].username, this.credentials[index].password, readonly);
             await this.clients[index]?.login();
         }
         return this.clients[index];

package/dist/leek-sync/leek-sync-client.d.ts

@@ -1,4 +1,4 @@
-import NodeLeekClient from "../node-leek-client/node-leek-client.js";
+import { NodeLeekClient } from "../node-leek-client/node-leek-client.js";
 import Filelist from "./filelist/filelist.js";
 export declare class LeekSyncClient {
     leekwarsFilelist: Filelist;

package/dist/leek-sync/leek-sync-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"leek-sync-client.d.ts","sourceRoot":"","sources":["../../src/leek-sync/leek-sync-client.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,yCAAyC,CAAC;AAKrE,OAAO,QAAQ,MAAM,wBAAwB,CAAC;AAa9C,qBAAa,cAAc;IAEvB,gBAAgB,EAAE,QAAQ,CAAA;IAC1B,aAAa,EAAE,QAAQ,CAAA;IAEvB,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,WAAW,CAAiB;gBAGxB,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM;IAQ3C,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM;YAiCnC,cAAc;IA4B5B,OAAO,CAAC,aAAa;CAQxB"}
+{"version":3,"file":"leek-sync-client.d.ts","sourceRoot":"","sources":["../../src/leek-sync/leek-sync-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAC,MAAM,yCAAyC,CAAC;AAKvE,OAAO,QAAQ,MAAM,wBAAwB,CAAC;AAa9C,qBAAa,cAAc;IAEvB,gBAAgB,EAAE,QAAQ,CAAA;IAC1B,aAAa,EAAE,QAAQ,CAAA;IAEvB,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,WAAW,CAAiB;gBAGxB,cAAc,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM;IAQ3C,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM;YAiCnC,cAAc;IA4B5B,OAAO,CAAC,aAAa;CAQxB"}

package/dist/leek-sync/leekfile-source/leekwars-source.d.ts

@@ -1,7 +1,7 @@
 import LeekFile from "../filelist/leekfile.js";
 import LeekfileSource from "./leekfile-source.js";
-import NodeLeekClient from "../../node-leek-client/node-leek-client.js";
 import Filelist from "../filelist/filelist.js";
+import { NodeLeekClient } from "../../node-leek-client/node-leek-client";
 declare class LeekwarsSource extends LeekfileSource {
     private nodeLeekClient;
     constructor(nodeLeekClient: NodeLeekClient, filelist: Filelist);

package/dist/leek-sync/leekfile-source/leekwars-source.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"leekwars-source.d.ts","sourceRoot":"","sources":["../../../src/leek-sync/leekfile-source/leekwars-source.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,yBAAyB,CAAC;AAC/C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,cAAc,MAAM,4CAA4C,CAAC;AACxE,OAAO,QAAQ,MAAM,yBAAyB,CAAC;AAE/C,cAAM,cAAe,SAAQ,cAAc;IACvC,OAAO,CAAC,cAAc,CAAiB;gBAE3B,cAAc,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ;IAKxD,IAAI;YAuBI,UAAU;IAoBxB,OAAO,CAAC,QAAQ;IAID,UAAU,CAAC,IAAI,EAAE,QAAQ;IAWzB,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;YAI1C,4BAA4B;YAO5B,oBAAoB;YASpB,oBAAoB;YAUpB,sBAAsB;YAItB,mBAAmB;IAcjC,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,aAAa;CAIxB;AAED,eAAe,cAAc,CAAC"}
+{"version":3,"file":"leekwars-source.d.ts","sourceRoot":"","sources":["../../../src/leek-sync/leekfile-source/leekwars-source.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,yBAAyB,CAAC;AAC/C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,QAAQ,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAC,cAAc,EAAC,MAAM,yCAAyC,CAAC;AAEvE,cAAM,cAAe,SAAQ,cAAc;IACvC,OAAO,CAAC,cAAc,CAAiB;gBAE3B,cAAc,EAAE,cAAc,EAAE,QAAQ,EAAE,QAAQ;IAKxD,IAAI;YAuBI,UAAU;IAoBxB,OAAO,CAAC,QAAQ;IAID,UAAU,CAAC,IAAI,EAAE,QAAQ;IAWzB,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;YAI1C,4BAA4B;YAO5B,oBAAoB;YASpB,oBAAoB;YAUpB,sBAAsB;YAItB,mBAAmB;IAcjC,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,aAAa;CAIxB;AAED,eAAe,cAAc,CAAC"}

package/dist/node-leek-client/node-leek-client.d.ts

@@ -3,7 +3,7 @@ import { Opponent } from "../codegen/model/opponent.js";
 import { FightResult } from "../codegen/model/fightResult.js";
 import { LeekWarsClient } from "./leek-wars-client.js";
 import { PublicLeek } from "../codegen/model/publicLeek.js";
-declare class NodeLeekClient extends LeekWarsClient {
+export declare class NodeLeekClient extends LeekWarsClient {
     farmer: Farmer;
     leeks: PublicLeek[];
     private foldersById;
@@ -25,6 +25,8 @@ declare class NodeLeekClient extends LeekWarsClient {
     getFiles(): {
         [name: string]: number;
     };
+    private getLocalLeekName;
+    getLeekName(id: number): Promise<string>;
     startRandomSoloFight(leek_id: number): Promise<[Opponent, number]>;
     startRandomFarmerFight(): Promise<[Opponent, number]>;
     startRandomTeamFight(leek_id: number): Promise<[Opponent, number]>;
@@ -33,5 +35,4 @@ declare class NodeLeekClient extends LeekWarsClient {
     createRoom(bossId: number, locked?: boolean): Promise<string>;
     joinRoom(roomId: string): Promise<string>;
 }
-export { NodeLeekClient as default };
 //# sourceMappingURL=node-leek-client.d.ts.map

package/dist/node-leek-client/node-leek-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node-leek-client.d.ts","sourceRoot":"","sources":["../../src/node-leek-client/node-leek-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,4BAA4B,CAAC;AAGlD,OAAO,EAAC,QAAQ,EAAC,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAC,WAAW,EAAC,MAAM,iCAAiC,CAAC;AAE5D,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,gCAAgC,CAAC;AAO1D,cAAM,cAAe,SAAQ,cAAc;IAEhC,MAAM,EAAE,MAAM,CAAgB;IAC9B,KAAK,EAAE,UAAU,EAAE,CAAM;IAChC,OAAO,CAAC,WAAW,CAAqC;IACxD,OAAO,CAAC,WAAW,CAAuC;IAC1D,OAAO,CAAC,cAAc,CAA+B;WAEjC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAK1E,KAAK;YAaJ,UAAU;IAWjB,cAAc;IAKrB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,aAAa;IAcrB,OAAO,CAAC,gBAAgB;YAQV,eAAe;IAO7B,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,UAAU;IAMX,QAAQ,IAAI;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAIhC,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAcnE,sBAAsB,IAAK,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IActD,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAcnE,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAI,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAWhE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,GAAE,MAAW;IAK1D,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAI,OAAO,CAAC,MAAM,CAAC;IAUrE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC;CAO1D;AAED,OAAO,EAAC,cAAc,IAAI,OAAO,EAAC,CAAC"}
+{"version":3,"file":"node-leek-client.d.ts","sourceRoot":"","sources":["../../src/node-leek-client/node-leek-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,4BAA4B,CAAC;AAGlD,OAAO,EAAC,QAAQ,EAAC,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAC,WAAW,EAAC,MAAM,iCAAiC,CAAC;AAE5D,OAAO,EAAC,cAAc,EAAC,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAC,UAAU,EAAC,MAAM,gCAAgC,CAAC;AAO1D,qBAAa,cAAe,SAAQ,cAAc;IAEvC,MAAM,EAAE,MAAM,CAAgB;IAC9B,KAAK,EAAE,UAAU,EAAE,CAAM;IAChC,OAAO,CAAC,WAAW,CAAqC;IACxD,OAAO,CAAC,WAAW,CAAuC;IAC1D,OAAO,CAAC,cAAc,CAA+B;WAEjC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAK1E,KAAK;YAaJ,UAAU;IAWjB,cAAc;IAKrB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,aAAa;IAcrB,OAAO,CAAC,gBAAgB;YAQV,eAAe;IAO7B,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,UAAU;IAMX,QAAQ,IAAI;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE;IAI7C,OAAO,CAAC,gBAAgB;IAIX,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIxC,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAcnE,sBAAsB,IAAK,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IActD,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAcnE,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAI,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IAWhE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,GAAE,MAAW;IAK1D,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,GAAI,OAAO,CAAC,MAAM,CAAC;IAUrE,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAI,OAAO,CAAC,MAAM,CAAC;CAO1D"}

package/dist/node-leek-client/node-leek-client.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = void 0;
+exports.NodeLeekClient = void 0;
 const farmer_js_1 = require("../codegen/model/farmer.js");
 const leek_sync_client_js_1 = require("../leek-sync/leek-sync-client.js");
 const leek_wars_client_js_1 = require("./leek-wars-client.js");
@@ -131,11 +131,17 @@ class NodeLeekClient extends leek_wars_client_js_1.LeekWarsClient {
     getFiles() {
         return this.filesByName;
     }
+    getLocalLeekName(id) {
+        return this.farmer.leeks[id]?.name;
+    }
+    async getLeekName(id) {
+        return this.getLocalLeekName(id) ?? (await this.getLeek(id))?.name ?? "Unknown";
+    }
     async startRandomSoloFight(leek_id) {
         return this.getSoloOpponents(leek_id)
             .then((opponents) => {
             if (opponents.length == 0) {
-                console.error("Can't find opponent for " + leek_id);
+                console.error("Can't find opponent for " + this.getLocalLeekName(leek_id));
                 return [null, -1];
             }
             const opponent = randomIn(opponents);
@@ -200,4 +206,4 @@ class NodeLeekClient extends leek_wars_client_js_1.LeekWarsClient {
         return this.currentRoom;
     }
 }
-exports.default = NodeLeekClient;
+exports.NodeLeekClient = NodeLeekClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-leek",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A library for interacting with LeekWars API.",
   "main": "dist/app.js",
   "types": "dist/app.d.ts",