corsinvest/cv4pve-api-javascript

Proxmox VE Client API JavaScript

cv4pve-api-javascript's Issues

src/index.js doesnt load

What happened?

i downloaded the file in src/index.js, and tried to load it in my normal file and got the following output

Expected behavior

it should have loaded up and excecuted, all i have is
const pve = require("./src/index")
in my file

Relevant log output

C:\Users\my username\Downloads\carea\src\index.js:198
    async #execute(method, resource, parameters) {
                  ^

SyntaxError: Unexpected token '('
    at wrapSafe (internal/modules/cjs/loader.js:1054:16)
    at Module._compile (internal/modules/cjs/loader.js:1102:27)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10)
    at Module.load (internal/modules/cjs/loader.js:986:32)
    at Function.Module._load (internal/modules/cjs/loader.js:879:14)
    at Module.require (internal/modules/cjs/loader.js:1026:19)
    at require (internal/modules/cjs/helpers.js:72:18)
    at Object.<anonymous> (C:\Users\ryan\Downloads\carea\index.js:2:13)
    at Module._compile (internal/modules/cjs/loader.js:1138:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1158:10)

Proxmox VE Version

7.0-11

Version (bug)

what

Version (working)

No response

On what operating system are you experiencing the issue?

Windows

Pull Request

• I would like to do a Pull Request

Simplified parameter setting

First of all, thank you for developing such a useful library for everyone to use. I find it very convenient.
I encountered a problem where PVE could not resolve the Token when using APIToken. I found that it was on line 229 of src/index.js

if (this.apiToken != '') { headers['Authorization'] = "PVEAPIToken " + this.apiToken; } 

There is a missing = after PVEAPIToken.
Currently, I can use it by adding an = in front of it, as follows:

 client.apiToken = '=' + this.configService.get('PVE_API_TOKEN');

Therefore, changing PVEAPIToken to PVEAPIToken= should make it easier for users to use.

File separation

I was reviewing the codebase as I was interested in using this for a personal project. I was wondering if you would be open to me creating a PR to separate everything within the index.js file into separate more appropriate files?

This will certainly help with readability and for future contributors.

I would have went ahead and done the change but figured I would ask beforehand, as I realised a lot of the code may be automatically generated, given its 17k lines.

feat: Type definitions for Response

Right now the project has great autocompletion for creating the requests. But not for responses from the API.

This change would make the package more usable.