experibass / esijs Goto Github PK

A simple Node module for EVE Onlines' ESI.

Home Page: https://github.com/ExperiBass/esiJS

License: GNU General Public License v3.0

JavaScript 100.00%

esijs's Introduction


  ____ _              ___         _         __  

 / ___(_)_ __   __ _ / / | ____ _| | ___ _ _\ \ 

| |  _| | '_ \ / _` | || |/ / _` | |/ _ \ '__| |

| |_| | | | | | (_| | ||   < (_| | |  __/ |  | |

 \____|_|_| |_|\__, | ||_|\_\__,_| |\___|_|  | |

               |___/ \_\         |_|        /_/

You've visited my profile. Oh no.

Quickstats

About Me

species: fox
age: yes
location: wouldn't you like to know?

Bio (or something)

im a goofy fox, floating through space and stealing your garlic bread >:3
most of my repos are just random ideas i have, with some being useful like esiJS and cli-pride-flags
massive linux, bitcoin, and tech nerd, feel free to poke me with questions uwu

Links

My website is the main hub for my profile, check it out for a full bio
If you like my code, feel free to support me via btc lightning at [email protected] :3
For on-chain, check my site uwu

esijs's People

Contributors

Stargazers

Watchers

Forkers

joemanfoo maxtsero geekyaubergine milocosmopolitan atomic-development quantumferret andrey-kovinjonok thource wmacomber

esijs's Issues

Type definition for `b0s` incorrect in market.js

The input validation requires it to be an object then the value is string

README example instantiation doesn't work

In the READMe.md file, your sample code uses a zero-argument constructor for the esiJS class:

const esiJS = require('esijs')
const esiClient = new esiJS()

This generates a TypeError: Cannot read property 'logging' of undefined because you need to instantiate using something like:

const esiJS = require('esijs')
const esiClient = new esiJS({logging: false})

The sample code in the 'How To Install esiJS' wiki page is also wrong (and still has require('esiJS') too).

Bug in README example?

I was trying out your library and I think I found a bug in the example.

The following resulted in "MODULE NOT FOUND".

const esiJS = require('esiJS')

Had to change it to:

const esiJS = require('esijs')

My platform is Ubuntu btw.

If you agree I can make a PR.

[BUG] Corporation Alliance History is setup wrong

The corporation group has an entry for corporationHistory that seems to be set up wrong.

esiJS/src/corporation.js

Lines 4 to 19 in 1465a28

 /** 

  * Get a list of all the aliances a corporation has been a member of. 

  * @param corporationID {number} The corporation to get the corporation history of. 

  * @returns {Promise<number[]>} A array of corporation IDs. 

  */ 

 corporationHistory(corporationID) { 

 inputValidation({ 

 input: corporationID, 

 type: 'number', 

 message: `The function 'corporation.corporationHistory' requires a corporation ID!` 

 }) 

 return request({ 

 subUrl: `corporations/${corporationID}/corporationhistory` 

 }) 

 },

The comment seems to acknowledge that this is meant to be for the corporation's alliance history, but it is named wrong and attempts to send a request to a corporations/${corporationID}/corporationhistory endpoint which doesn't exist.

I believe this may be a copy-paste error and needs to be updated to point at the /corporations/${corporationID}/alliancehistory/ ESI route instead.

Auth support?

Is there a way to make authenticated requests?

killMails.js has incorrect casing in npm version

In endpoints.js, killMails.js is imported as killmails: require('./Functions/killMails'),. The version available on npm has the file kill mails cased as killmails.js resulting in not node/webpack being able to import the file. The file is correctly typed within the source code though which leads me to believe it is related to the build system used. As such I don't think I am able to fix this with a pr, what build system are you using?

A few errors

Had a few immediate failures when pulling this in. Here they are (simple fixes?):

/node_modules/esijs/Functions/utility.js:24
        let path = 'latest v1 legacy dev'.split(' ')
            ^

SyntaxError: Identifier 'path' has already been declared

and

internal/modules/cjs/loader.js:797
    throw err;
    ^

Error: Cannot find module './Functions/killmails'
Require stack:
- /.../node_modules/esijs/endpoints.js
...

(node:26643) UnhandledPromiseRejectionWarning: ReferenceError: categoryID is not defined
Code seems to be taking the wrong input:

constellationInfo (constellationID) {
    inputValidation({ input: categoryID, type: 'number', message: `The function 'universe.constellations.constellationInfo requires a constellation Id!` })
    
    return request({ subUrl: `universe/constellations/${constellationID}` })
},

^ This one is fixed in this Pull Request: #8

	/**
	* Get a list of all the aliances a corporation has been a member of.
	* @param corporationID {number} The corporation to get the corporation history of.
	* @returns {Promise<number[]>} A array of corporation IDs.
	*/
	corporationHistory(corporationID) {
	inputValidation({
	input: corporationID,
	type: 'number',
	message: `The function 'corporation.corporationHistory' requires a corporation ID!`
	})

	return request({
	subUrl: `corporations/${corporationID}/corporationhistory`
	})
	},