@localisprimary/esi 2.0.8 → 2.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +87 -80
  2. package/dist/client.d.ts +9 -2
  3. package/dist/client.js +10 -3
  4. package/dist/types.d.ts +17 -14
  5. package/package.json +52 -55
package/README.md CHANGED
@@ -2,19 +2,20 @@
2
2
 
3
3
  A slightly opinionated TypeScript client for the [EVE Online API](https://developers.eveonline.com/api-explorer).
4
4
 
5
-
6
5
  [![NPM Version](https://img.shields.io/npm/v/%40localisprimary%2Fesi)](https://www.npmjs.com/package/@localisprimary/esi)
7
6
  [![NPM Downloads](https://img.shields.io/npm/dm/%40localisprimary%2Fesi?link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40localisprimary%2Fesi)](https://www.npmjs.com/package/@localisprimary/esi)
8
7
  [![Discord](https://img.shields.io/discord/928842307879444552?label=discord&color=%237289da&link=https%3A%2F%2Fdiscord.gg%2FCbcBHGMpUa)](https://discord.gg/CbcBHGMpUa)
9
8
 
10
-
11
9
  ## Usage
12
10
 
13
11
  ```typescript
14
12
  import { EsiClient } from '@localisprimary/esi'
15
13
 
16
14
  // Create client (optionally with auth token)
17
- const esi = new EsiClient({ userAgent: 'foo@example.com', token: 'bearer-token' })
15
+ const esi = new EsiClient({
16
+ userAgent: 'foo@example.com',
17
+ token: 'bearer-token',
18
+ })
18
19
 
19
20
  // Get all alliances
20
21
  const alliances = await esi.getAlliances()
@@ -30,7 +31,7 @@ console.log(alliance.data)
30
31
  The `EsiClient` constructor requires an options object with the following properties:
31
32
  | Parameter | Description | Type | Default | Required |
32
33
  |-----------|-------------|------|---------|----------|
33
- | `userAgent` | Resolves to `"localisprimary/esi <userAgent>"` | `string` | | Yes |
34
+ | `userAgent` | Resolves to `"localisprimary/esi <userAgent>"` | `string` | | Yes |
34
35
  | `token` | Optional auth token | `string` | `undefined` | No |
35
36
  | `useRequestHeaders` | If false, use query parameters for userAgent and token | `boolean` | `true` | No |
36
37
 
@@ -40,22 +41,26 @@ This client provides methods for all EVE ESI endpoints. Methods return a `Promis
40
41
 
41
42
  ```typescript
42
43
  interface EsiResponse<TData, THeaders = Record<string, string>> {
43
- data: TData;
44
- status: number;
45
- headers: THeaders;
44
+ data: TData
45
+ status: number
46
+ headers: THeaders
46
47
  }
47
48
 
48
49
  interface EsiError {
49
- error: string;
50
- status: number;
50
+ error: string
51
+ status: number
51
52
  }
52
53
  ```
53
54
 
54
55
  All methods are fully typed: `getAlliance` will take `GetAllianceParams` and return `GetAllianceResponse`.
55
56
 
56
57
  `Params` types make no distinction between path, query, or body parameters, it's all the same object:
58
+
57
59
  ```typescript
58
- const esi = new EsiClient({ userAgent: 'foo@example.com', token: 'bearer-token' })
60
+ const esi = new EsiClient({
61
+ userAgent: 'foo@example.com',
62
+ token: 'bearer-token',
63
+ })
59
64
 
60
65
  // POST https://esi.evetech.net/characters/{character_id}/mail
61
66
  esi.postCharacterMail({
@@ -64,77 +69,81 @@ esi.postCharacterMail({
64
69
 
65
70
  // request body
66
71
  approved_cost: 0,
67
- body: "Hello from the ESI!",
68
- recipients: [{ recipient_type: 'character', recipient_id: 96135698 }]
72
+ body: 'Hello from the ESI!',
73
+ recipients: [{ recipient_type: 'character', recipient_id: 96135698 }],
69
74
  })
70
75
  ```
71
76
 
72
- | Method | Description
73
- |--------|-------------|
74
- | [`getAlliance`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceId) | Public information about an alliance |
75
- | [`getAllianceContacts`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdContacts) | Return contacts of an alliance |
76
- | [`getAllianceContactsLabels`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdContactsLabels) | Return custom labels for an alliance's contacts |
77
- | [`getAllianceCorporations`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdCorporations) | List all current member corporations of an alliance |
78
- | [`getAllianceIcons`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdIcons) | Get the icon urls for a alliance. This route expires daily at 11:05 |
79
- | [`getAlliances`](https://developers.eveonline.com/api-explorer#/operations/GetAlliances) | List all active player alliances |
80
- | [`getCharacter`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterId) | Public information about a character |
81
- | [`getCharacterAgentsResearch`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdAgentsResearch) | Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) |
82
- | [`getCharacterAssets`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdAssets) | Return a list of the characters assets |
83
- | [`postCharacterAssetsLocations`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdAssetsLocations) | Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) |
84
- | [`postCharacterAssetsNames`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdAssetsNames) | Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. |
85
- | [`getCharacterAttributes`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdAttributes) | Return attributes of a character |
86
- | [`getCharacterBlueprints`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdBlueprints) | Return a list of blueprints the character owns |
87
- | [`getCharacterCalendar`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCalendar) | Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event |
88
- | [`getCharacterCalendarEventAttendees`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCalendarEventIdAttendees) | Get all invited attendees for a given event |
89
- | [`getCharacterCalendarEventId`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCalendarEventId) | Get all the information for a specific event |
90
- | [`putCharacterCalendarEventId`](https://developers.eveonline.com/api-explorer#/operations/PutCharactersCharacterIdCalendarEventId) | Set your response status to an event |
91
- | [`getCharacterClones`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdClones) | A list of the character's clones |
92
- | [`deleteCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdContacts) | Bulk delete contacts |
93
- | [`getCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContacts) | Return contacts of a character |
94
- | [`postCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdContacts) | Bulk add contacts with same settings |
95
- | [`putCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/PutCharactersCharacterIdContacts) | Bulk edit contacts with same settings |
96
- | [`getCharacterContactsLabels`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContactsLabels) | Return custom labels for a character's contacts |
97
- | [`getCharacterContractBids`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContractsContractIdBids) | Lists bids on a particular auction contract |
98
- | [`getCharacterContractItems`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContractsContractIdItems) | Lists items of a particular contract |
99
- | [`getCharacterContracts`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContracts) | Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress". |
100
- | [`getCharacterCorporationhistory`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCorporationhistory) | Get a list of all the corporations a character has been a member of |
101
- | [`postCharacterCspa`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdCspa) | Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost |
102
- | [`getCharacterFatigue`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFatigue) | Return a character's jump activation and fatigue information |
103
- | [`deleteCharacterFitting`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdFittingsFittingId) | Delete a fitting from a character |
104
- | [`getCharacterFittings`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFittings) | Return fittings of a character |
105
- | [`postCharacterFittings`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdFittings) | Save a new fitting for a character |
106
- | [`getCharacterFleet`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFleet) | Return the fleet ID the character is in, if any. |
107
- | [`getCharacterFwStats`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFwStats) | Statistical overview of a character involved in faction warfare. This route expires daily at 11:05 |
108
- | [`getCharacterImplants`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdImplants) | Return implants on the active clone of a character |
109
- | [`getCharacterIndustryJobs`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdIndustryJobs) | List industry jobs placed by a character |
110
- | [`getCharacterKillmailsRecent`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdKillmailsRecent) | Return a list of a character's kills and losses going back 90 days |
111
- | [`getCharacterLocation`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdLocation) | Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable |
112
- | [`getCharacterLoyaltyPoints`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdLoyaltyPoints) | Return a list of loyalty points for all corporations the character has worked for |
113
- | [`getCharacterMail`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMail) | Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards |
114
- | [`postCharacterMail`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdMail) | Create and send a new mail |
115
- | [`deleteCharacterMailLabel`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdMailLabelsLabelId) | Delete a mail label |
116
- | [`getCharacterMailLabels`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMailLabels) | Return a list of the users mail labels, unread counts for each label and a total unread count. |
117
- | [`postCharacterMailLabels`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdMailLabels) | Create a mail label |
118
- | [`getCharacterMailLists`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMailLists) | Return all mailing lists that the character is subscribed to |
119
- | [`deleteCharacterMailMailId`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdMailMailId) | Delete a mail |
120
- | [`getCharacterMailMailId`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMailMailId) | Return the contents of an EVE mail |
121
- | [`putCharacterMailMailId`](https://developers.eveonline.com/api-explorer#/operations/PutCharactersCharacterIdMailMailId) | Update metadata about a mail |
122
- | [`getCharacterMedals`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMedals) | Return a list of medals the character has |
123
- | [`getCharacterMining`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMining) | Paginated record of all mining done by a character for the past 30 days |
124
- | [`getCharacterNotifications`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdNotifications) | Return character notifications |
125
- | [`getCharacterNotificationsContacts`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdNotificationsContacts) | Return notifications about having been added to someone's contact list |
126
- | [`getCharacterOnline`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdOnline) | Checks if the character is currently online |
127
- | [`getCharacterOrders`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdOrders) | List open market orders placed by a character |
128
- | [`getCharacterOrdersHistory`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdOrdersHistory) | List cancelled and expired market orders placed by a character up to 90 days in the past. |
129
- | [`getCharacterPlanet`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdPlanetsPlanetId) | Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. |
130
- | [`getCharacterPlanets`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdPlanets) | Returns a list of all planetary colonies owned by a character. |
131
- | [`getCharacterPortrait`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdPortrait) | Get portrait urls for a character. This route expires daily at 11:05 |
132
- | [`getCharacterRoles`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdRoles) | Returns a character's corporation roles |
133
- | [`postCharactersAffiliation`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersAffiliation) | Bulk lookup of character IDs to corporation, alliance and faction |
134
- | [`getCharacterSearch`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSearch) | Search for entities that match a given sub-string. |
135
- | [`getCharacterShip`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdShip) | Get the current ship type, name and id |
136
- | [`getCharacterSkillqueue`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkillqueue) | List the configured skill queue for the given character |
137
- | [`getCharacterSkills`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkills) | List all trained skills for the given character |
77
+ | Method | Description |
78
+ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
79
+ | [`getAlliance`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceId) | Public information about an alliance |
80
+ | [`getAllianceContacts`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdContacts) | Return contacts of an alliance |
81
+ | [`getAllianceContactsLabels`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdContactsLabels) | Return custom labels for an alliance's contacts |
82
+ | [`getAllianceCorporations`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdCorporations) | List all current member corporations of an alliance |
83
+ | [`getAllianceIcons`](https://developers.eveonline.com/api-explorer#/operations/GetAlliancesAllianceIdIcons) | Get the icon urls for a alliance. This route expires daily at 11:05 |
84
+ | [`getAlliances`](https://developers.eveonline.com/api-explorer#/operations/GetAlliances) | List all active player alliances |
85
+ | [`getCharacter`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterId) | Public information about a character |
86
+ | [`getCharacterAgentsResearch`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdAgentsResearch) | Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay \* days(currentTime - researchStartDate) |
87
+ | [`getCharacterAssets`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdAssets) | Return a list of the characters assets |
88
+ | [`postCharacterAssetsLocations`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdAssetsLocations) | Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) |
89
+ | [`postCharacterAssetsNames`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdAssetsNames) | Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. |
90
+ | [`getCharacterAttributes`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdAttributes) | Return attributes of a character |
91
+ | [`getCharacterBlueprints`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdBlueprints) | Return a list of blueprints the character owns |
92
+ | [`getCharacterCalendar`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCalendar) | Get 50 event summaries from the calendar. If no from_event ID is given, the resource will return the next 50 chronological event summaries from now. If a from_event ID is specified, it will return the next 50 chronological event summaries from after that event |
93
+ | [`getCharacterCalendarEventAttendees`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCalendarEventIdAttendees) | Get all invited attendees for a given event |
94
+ | [`getCharacterCalendarEventId`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCalendarEventId) | Get all the information for a specific event |
95
+ | [`putCharacterCalendarEventId`](https://developers.eveonline.com/api-explorer#/operations/PutCharactersCharacterIdCalendarEventId) | Set your response status to an event |
96
+ | [`getCharacterClones`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdClones) | A list of the character's clones |
97
+ | [`deleteCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdContacts) | Bulk delete contacts |
98
+ | [`getCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContacts) | Return contacts of a character |
99
+ | [`postCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdContacts) | Bulk add contacts with same settings |
100
+ | [`putCharacterContacts`](https://developers.eveonline.com/api-explorer#/operations/PutCharactersCharacterIdContacts) | Bulk edit contacts with same settings |
101
+ | [`getCharacterContactsLabels`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContactsLabels) | Return custom labels for a character's contacts |
102
+ | [`getCharacterContractBids`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContractsContractIdBids) | Lists bids on a particular auction contract |
103
+ | [`getCharacterContractItems`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContractsContractIdItems) | Lists items of a particular contract |
104
+ | [`getCharacterContracts`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdContracts) | Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is "in_progress". |
105
+ | [`getCharacterCorporationhistory`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdCorporationhistory) | Get a list of all the corporations a character has been a member of |
106
+ | [`postCharacterCspa`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdCspa) | Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost |
107
+ | [`getCharacterFatigue`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFatigue) | Return a character's jump activation and fatigue information |
108
+ | [`deleteCharacterFitting`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdFittingsFittingId) | Delete a fitting from a character |
109
+ | [`getCharacterFittings`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFittings) | Return fittings of a character |
110
+ | [`postCharacterFittings`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdFittings) | Save a new fitting for a character |
111
+ | [`getCharacterFleet`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFleet) | Return the fleet ID the character is in, if any. |
112
+ | [`getCharacterFwStats`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdFwStats) | Statistical overview of a character involved in faction warfare. This route expires daily at 11:05 |
113
+ | [`getCharacterImplants`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdImplants) | Return implants on the active clone of a character |
114
+ | [`getCharacterIndustryJobs`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdIndustryJobs) | List industry jobs placed by a character |
115
+ | [`getCharacterKillmailsRecent`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdKillmailsRecent) | Return a list of a character's kills and losses going back 90 days |
116
+ | [`getCharacterLocation`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdLocation) | Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable |
117
+ | [`getCharacterLoyaltyPoints`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdLoyaltyPoints) | Return a list of loyalty points for all corporations the character has worked for |
118
+ | [`getCharacterMail`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMail) | Return the 50 most recent mail headers belonging to the character that match the query criteria. Queries can be filtered by label, and last_mail_id can be used to paginate backwards |
119
+ | [`postCharacterMail`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdMail) | Create and send a new mail |
120
+ | [`deleteCharacterMailLabel`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdMailLabelsLabelId) | Delete a mail label |
121
+ | [`getCharacterMailLabels`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMailLabels) | Return a list of the users mail labels, unread counts for each label and a total unread count. |
122
+ | [`postCharacterMailLabels`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersCharacterIdMailLabels) | Create a mail label |
123
+ | [`getCharacterMailLists`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMailLists) | Return all mailing lists that the character is subscribed to |
124
+ | [`deleteCharacterMailMailId`](https://developers.eveonline.com/api-explorer#/operations/DeleteCharactersCharacterIdMailMailId) | Delete a mail |
125
+ | [`getCharacterMailMailId`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMailMailId) | Return the contents of an EVE mail |
126
+ | [`putCharacterMailMailId`](https://developers.eveonline.com/api-explorer#/operations/PutCharactersCharacterIdMailMailId) | Update metadata about a mail |
127
+ | [`getCharacterMedals`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMedals) | Return a list of medals the character has |
128
+ | [`getCharacterMining`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdMining) | Paginated record of all mining done by a character for the past 30 days |
129
+ | [`getCharacterNotifications`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdNotifications) | Return character notifications |
130
+ | [`getCharacterNotificationsContacts`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdNotificationsContacts) | Return notifications about having been added to someone's contact list |
131
+ | [`getCharacterOnline`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdOnline) | Checks if the character is currently online |
132
+ | [`getCharacterOrders`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdOrders) | List open market orders placed by a character |
133
+ | [`getCharacterOrdersHistory`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdOrdersHistory) | List cancelled and expired market orders placed by a character up to 90 days in the past. |
134
+ | [`getCharacterPlanet`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdPlanetsPlanetId) | Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. |
135
+ | [`getCharacterPlanets`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdPlanets) | Returns a list of all planetary colonies owned by a character. |
136
+ | [`getCharacterPortrait`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdPortrait) | Get portrait urls for a character. This route expires daily at 11:05 |
137
+ | [`getCharacterRoles`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdRoles) | Returns a character's corporation roles |
138
+ | [`postCharactersAffiliation`](https://developers.eveonline.com/api-explorer#/operations/PostCharactersAffiliation) | Bulk lookup of character IDs to corporation, alliance and faction |
139
+ | [`getCharacterSearch`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSearch) | Search for entities that match a given sub-string. |
140
+ | [`getCharacterShip`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdShip) | Get the current ship type, name and id |
141
+ | [`getCharacterSkillqueue`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkillqueue) | List the configured skill queue for the given character. Entries that have their finish time in the past are completed, but aren't updated in the "/skills" route |
142
+ | yet. This will happen the next time the character logs in. |
143
+ | [`getCharacterSkills`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkills) | List all trained skills for the given character. Skills returned by this route can be out-of-date if the character hasn't logged in since one or more skills |
144
+
145
+ completed training. Use the /skillqueue route to check for skills that completed training. Entries that are
146
+ in the past need to be applied on top of this list to get an accurate view of the character's current skills. |
138
147
  | [`getCharacterStandings`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdStandings) | Return character standings from agents, NPC corporations, and factions |
139
148
  | [`getCharacterTitles`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdTitles) | Returns a character's titles |
140
149
  | [`getCharacterWallet`](https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdWallet) | Returns a character's wallet balance |
@@ -269,6 +278,4 @@ esi.postCharacterMail({
269
278
  | [`getWarKillmails`](https://developers.eveonline.com/api-explorer#/operations/GetWarsWarIdKillmails) | Return a list of kills related to a war |
270
279
  | [`getWars`](https://developers.eveonline.com/api-explorer#/operations/GetWars) | Return a list of wars |
271
280
 
272
-
273
-
274
281
  [![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-green.svg)](https://buymeacoffee.com/nfinished)
package/dist/client.d.ts CHANGED
@@ -389,13 +389,20 @@ export declare class EsiClient {
389
389
  */
390
390
  getCharacterShip(params: Types.GetCharacterShipParams): Promise<Types.EsiResponse<Types.GetCharacterShipResponse, Types.GetCharacterShipResponseHeaders>>;
391
391
  /**
392
- * List the configured skill queue for the given character
392
+ * List the configured skill queue for the given character.
393
+
394
+ * Entries that have their finish time in the past are completed, but aren't updated in the "/skills" route
395
+ yet. This will happen the next time the character logs in.
393
396
 
394
397
  * @see https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkillqueue
395
398
  */
396
399
  getCharacterSkillqueue(params: Types.GetCharacterSkillqueueParams): Promise<Types.EsiResponse<Types.GetCharacterSkillqueueResponse, Types.GetCharacterSkillqueueResponseHeaders>>;
397
400
  /**
398
- * List all trained skills for the given character
401
+ * List all trained skills for the given character.
402
+
403
+ * Skills returned by this route can be out-of-date if the character hasn't logged in since one or more skills
404
+ completed training. Use the /skillqueue route to check for skills that completed training. Entries that are
405
+ in the past need to be applied on top of this list to get an accurate view of the character's current skills.
399
406
 
400
407
  * @see https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkills
401
408
  */
package/dist/client.js CHANGED
@@ -1,4 +1,4 @@
1
- const COMPATIBILITY_DATE = '2026-01-16';
1
+ const COMPATIBILITY_DATE = '2026-01-27';
2
2
  export class EsiClient {
3
3
  constructor(options) {
4
4
  this.baseUrl = 'https://esi.evetech.net';
@@ -670,7 +670,10 @@ export class EsiClient {
670
670
  return this.request('GET', path, undefined, undefined);
671
671
  }
672
672
  /**
673
- * List the configured skill queue for the given character
673
+ * List the configured skill queue for the given character.
674
+
675
+ * Entries that have their finish time in the past are completed, but aren't updated in the "/skills" route
676
+ yet. This will happen the next time the character logs in.
674
677
 
675
678
  * @see https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkillqueue
676
679
  */
@@ -679,7 +682,11 @@ export class EsiClient {
679
682
  return this.request('GET', path, undefined, undefined);
680
683
  }
681
684
  /**
682
- * List all trained skills for the given character
685
+ * List all trained skills for the given character.
686
+
687
+ * Skills returned by this route can be out-of-date if the character hasn't logged in since one or more skills
688
+ completed training. Use the /skillqueue route to check for skills that completed training. Entries that are
689
+ in the past need to be applied on top of this list to get an accurate view of the character's current skills.
683
690
 
684
691
  * @see https://developers.eveonline.com/api-explorer#/operations/GetCharactersCharacterIdSkills
685
692
  */
package/dist/types.d.ts CHANGED
@@ -1039,16 +1039,18 @@ export interface GetCharacterShipResponseHeaders {
1039
1039
  ETag?: string;
1040
1040
  'Last-Modified'?: string;
1041
1041
  }
1042
- export type GetCharacterSkillqueueResponse = {
1043
- finish_date: string;
1042
+ export type TypeID = number;
1043
+ export interface CharactersSkillqueueSkill {
1044
+ finish_date?: string;
1044
1045
  finished_level: number;
1045
- level_end_sp: number;
1046
- level_start_sp: number;
1046
+ level_end_sp?: number;
1047
+ level_start_sp?: number;
1047
1048
  queue_position: number;
1048
- skill_id: number;
1049
- start_date: string;
1050
- training_start_sp: number;
1051
- }[];
1049
+ skill_id: TypeID;
1050
+ start_date?: string;
1051
+ training_start_sp?: number;
1052
+ }
1053
+ export type GetCharacterSkillqueueResponse = CharactersSkillqueueSkill[];
1052
1054
  export interface GetCharacterSkillqueueParams {
1053
1055
  character_id: number | string;
1054
1056
  }
@@ -1057,13 +1059,14 @@ export interface GetCharacterSkillqueueResponseHeaders {
1057
1059
  ETag?: string;
1058
1060
  'Last-Modified'?: string;
1059
1061
  }
1062
+ export interface CharactersSkillsSkill {
1063
+ active_skill_level: number;
1064
+ skill_id: number;
1065
+ skillpoints_in_skill: number;
1066
+ trained_skill_level: number;
1067
+ }
1060
1068
  export interface GetCharacterSkillsResponse {
1061
- skills: {
1062
- active_skill_level: number;
1063
- skill_id: number;
1064
- skillpoints_in_skill: number;
1065
- trained_skill_level: number;
1066
- }[];
1069
+ skills: CharactersSkillsSkill[];
1067
1070
  total_sp: number;
1068
1071
  unallocated_sp?: number;
1069
1072
  }
package/package.json CHANGED
@@ -1,57 +1,54 @@
1
1
  {
2
- "name": "@localisprimary/esi",
3
- "version": "2.0.8",
4
- "type": "module",
5
- "description": "Auto-generated TypeScript client for the EVE Online API",
6
- "main": "dist/index.js",
7
- "types": "dist/index.d.ts",
8
- "sideEffects": false,
9
- "scripts": {
10
- "fetch-schema": "node scripts/fetch-schema.ts",
11
- "generate": "node scripts/generate.ts && pnpm lint:fix",
12
- "build": "rimraf dist && tsc",
13
- "compile": "pnpm fetch-schema && pnpm generate && pnpm build && pnpm test",
14
- "lint": "eslint src",
15
- "lint:fix": "eslint src --fix",
16
- "test": "vitest run",
17
- "change": "beachball change"
18
- },
19
- "keywords": [
20
- "eve",
21
- "eveonline",
22
- "eve online",
23
- "esi",
24
- "api",
25
- "client",
26
- "typescript"
27
- ],
28
- "author": "Adam Trager <hello@adamtrager.com>",
29
- "funding": "https://buymeacoffee.com/nfinished",
30
- "repository": {
31
- "type": "git",
32
- "url": "https://github.com/localisprimary/esi.git"
33
- },
34
- "license": "ISC",
35
- "devDependencies": {
36
- "@types/node": "^24.10.0",
37
- "@typescript-eslint/eslint-plugin": "^8.46.2",
38
- "@typescript-eslint/parser": "^8.46.2",
39
- "@vitest/ui": "^4.0.6",
40
- "beachball": "^2.56.0",
41
- "camelcase": "^8.0.0",
42
- "eslint": "^9.39.0",
43
- "eslint-config-prettier": "^10.1.8",
44
- "eslint-plugin-prettier": "^5.5.4",
45
- "prettier": "^3.6.2",
46
- "rimraf": "^6.1.0",
47
- "typescript": "^5.9.3",
48
- "vitest": "^4.0.6"
49
- },
50
- "files": [
51
- "dist/**/*"
52
- ],
53
- "engines": {
54
- "node": "^24.4.1"
55
- },
56
- "packageManager": "pnpm@10.20.0+sha512.cf9998222162dd85864d0a8102e7892e7ba4ceadebbf5a31f9c2fce48dfce317a9c53b9f6464d1ef9042cba2e02ae02a9f7c143a2b438cd93c91840f0192b9dd"
2
+ "name": "@localisprimary/esi",
3
+ "version": "2.0.10",
4
+ "type": "module",
5
+ "description": "Auto-generated TypeScript client for the EVE Online API",
6
+ "main": "dist/index.js",
7
+ "types": "dist/index.d.ts",
8
+ "sideEffects": false,
9
+ "scripts": {
10
+ "fetch-schema": "node scripts/fetch-schema.ts",
11
+ "generate": "node scripts/generate.ts && pnpm lint:fix && pnpm format",
12
+ "build": "rimraf dist && tsc",
13
+ "compile": "pnpm fetch-schema && pnpm generate && pnpm build && pnpm test",
14
+ "lint": "oxlint src",
15
+ "lint:fix": "oxlint src --fix",
16
+ "format": "oxfmt",
17
+ "test": "vitest run",
18
+ "change": "beachball change"
19
+ },
20
+ "keywords": [
21
+ "eve",
22
+ "eveonline",
23
+ "eve online",
24
+ "esi",
25
+ "api",
26
+ "client",
27
+ "typescript"
28
+ ],
29
+ "author": "Adam Trager <hello@adamtrager.com>",
30
+ "funding": "https://buymeacoffee.com/nfinished",
31
+ "repository": {
32
+ "type": "git",
33
+ "url": "https://github.com/localisprimary/esi.git"
34
+ },
35
+ "license": "ISC",
36
+ "devDependencies": {
37
+ "@types/node": "^24.10.9",
38
+ "@vitest/ui": "^4.0.18",
39
+ "beachball": "^2.63.0",
40
+ "camelcase": "^9.0.0",
41
+ "oxfmt": "^0.28.0",
42
+ "oxlint": "^1.43.0",
43
+ "rimraf": "^6.1.2",
44
+ "typescript": "^5.9.3",
45
+ "vitest": "^4.0.18"
46
+ },
47
+ "files": [
48
+ "dist/**/*"
49
+ ],
50
+ "engines": {
51
+ "node": "^24.13.0"
52
+ },
53
+ "packageManager": "pnpm@10.28.2+sha512.41872f037ad22f7348e3b1debbaf7e867cfd448f2726d9cf74c08f19507c31d2c8e7a11525b983febc2df640b5438dee6023ebb1f84ed43cc2d654d2bc326264"
57
54
  }