eve-esi-types 1.0.0 → 2.0.0-beta

package/v2/post_universe_ids_ok.d.ts

@@ -0,0 +1,241 @@
+/**
+ * ESI endpoint: /universe/ids/
+ */
+
+/**
+ * id integer
+ */
+type PostUniverseIdsId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsName = string;
+/**
+ * agents array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsAgents = PostUniverseIdsAgent[];
+/**
+ * id integer
+ */
+type PostUniverseIdsAllianceId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsAllianceName = string;
+/**
+ * alliances array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsAlliances = PostUniverseIdsAlliance[];
+/**
+ * id integer
+ */
+type PostUniverseIdsCharacterId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsCharacterName = string;
+/**
+ * characters array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsCharacters = PostUniverseIdsCharacter[];
+/**
+ * id integer
+ */
+type PostUniverseIdsConstellationId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsConstellationName = string;
+/**
+ * constellations array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsConstellations = PostUniverseIdsConstellation[];
+/**
+ * id integer
+ */
+type PostUniverseIdsCorporationId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsCorporationName = string;
+/**
+ * corporations array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsCorporations = PostUniverseIdsCorporation[];
+/**
+ * id integer
+ */
+type PostUniverseIdsFactionId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsFactionName = string;
+/**
+ * factions array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsFactions = PostUniverseIdsFaction[];
+/**
+ * id integer
+ */
+type PostUniverseIdsInventoryTypeId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsInventoryTypeName = string;
+/**
+ * inventory_types array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsInventoryTypes = PostUniverseIdsInventoryType[];
+/**
+ * id integer
+ */
+type PostUniverseIdsRegionId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsRegionName = string;
+/**
+ * regions array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsRegions = PostUniverseIdsRegion[];
+/**
+ * id integer
+ */
+type PostUniverseIdsStationId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsStationName = string;
+/**
+ * stations array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsStations = PostUniverseIdsStation[];
+/**
+ * id integer
+ */
+type PostUniverseIdsSystemId = number;
+/**
+ * name string
+ */
+type PostUniverseIdsSystemName = string;
+/**
+ * systems array
+ *
+ * @maxItems 500
+ */
+type PostUniverseIdsSystems = PostUniverseIdsSystem[];
+
+/**
+ * 200 ok object
+ */
+interface PostUniverseIdsOk {
+  agents?: PostUniverseIdsAgents;
+  alliances?: PostUniverseIdsAlliances;
+  characters?: PostUniverseIdsCharacters;
+  constellations?: PostUniverseIdsConstellations;
+  corporations?: PostUniverseIdsCorporations;
+  factions?: PostUniverseIdsFactions;
+  inventory_types?: PostUniverseIdsInventoryTypes;
+  regions?: PostUniverseIdsRegions;
+  stations?: PostUniverseIdsStations;
+  systems?: PostUniverseIdsSystems;
+  [k: string]: unknown | undefined;
+}
+/**
+ * agent object
+ */
+interface PostUniverseIdsAgent {
+  id?: PostUniverseIdsId;
+  name?: PostUniverseIdsName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * alliance object
+ */
+interface PostUniverseIdsAlliance {
+  id?: PostUniverseIdsAllianceId;
+  name?: PostUniverseIdsAllianceName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * character object
+ */
+interface PostUniverseIdsCharacter {
+  id?: PostUniverseIdsCharacterId;
+  name?: PostUniverseIdsCharacterName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * constellation object
+ */
+interface PostUniverseIdsConstellation {
+  id?: PostUniverseIdsConstellationId;
+  name?: PostUniverseIdsConstellationName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * corporation object
+ */
+interface PostUniverseIdsCorporation {
+  id?: PostUniverseIdsCorporationId;
+  name?: PostUniverseIdsCorporationName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * faction object
+ */
+interface PostUniverseIdsFaction {
+  id?: PostUniverseIdsFactionId;
+  name?: PostUniverseIdsFactionName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * inventory_type object
+ */
+interface PostUniverseIdsInventoryType {
+  id?: PostUniverseIdsInventoryTypeId;
+  name?: PostUniverseIdsInventoryTypeName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * region object
+ */
+interface PostUniverseIdsRegion {
+  id?: PostUniverseIdsRegionId;
+  name?: PostUniverseIdsRegionName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * station object
+ */
+interface PostUniverseIdsStation {
+  id?: PostUniverseIdsStationId;
+  name?: PostUniverseIdsStationName;
+  [k: string]: unknown | undefined;
+}
+/**
+ * system object
+ */
+interface PostUniverseIdsSystem {
+  id?: PostUniverseIdsSystemId;
+  name?: PostUniverseIdsSystemName;
+  [k: string]: unknown | undefined;
+}

package/v2/post_universe_names_ok.d.ts

@@ -0,0 +1,41 @@
+/**
+ * ESI endpoint: /universe/names/
+ */
+
+/**
+ * category string
+ */
+type PostUniverseNamesCategory =
+  | "alliance"
+  | "character"
+  | "constellation"
+  | "corporation"
+  | "inventory_type"
+  | "region"
+  | "solar_system"
+  | "station"
+  | "faction";
+/**
+ * id integer
+ */
+type PostUniverseNamesId = number;
+/**
+ * name string
+ */
+type PostUniverseNamesName = string;
+/**
+ * 200 ok array
+ *
+ * @maxItems 1000
+ */
+type PostUniverseNamesOk = PostUniverseNames_200Ok[];
+
+/**
+ * 200 ok object
+ */
+interface PostUniverseNames_200Ok {
+  category: PostUniverseNamesCategory;
+  id: PostUniverseNamesId;
+  name: PostUniverseNamesName;
+  [k: string]: unknown | undefined;
+}

package/v2/put_characters_character_id_calendar_event_id_response.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ESI endpoint: /characters/{character_id}/calendar/{event_id}/
+ */
+
+/**
+ * response string
+ */
+type PutCharactersCharacterIdCalendarEventIdResponseResponse = "accepted" | "declined" | "tentative";
+
+/**
+ * response object
+ */
+interface PutCharactersCharacterIdCalendarEventIdResponse {
+  response: PutCharactersCharacterIdCalendarEventIdResponseResponse;
+  [k: string]: unknown | undefined;
+}

package/v2/put_characters_character_id_contacts_contact_ids.d.ts

@@ -0,0 +1,18 @@
+/**
+ * ESI endpoint: /characters/{character_id}/contacts/
+ */
+
+/**
+ * contact_ids array
+ *
+ * @minItems 1
+ * @maxItems 100
+ */
+type PutCharactersCharacterIdContactsContactIds = [
+  PutCharactersCharacterIdContactsContactId,
+  ...PutCharactersCharacterIdContactsContactId[]
+];
+/**
+ * ID of the contact to edit
+ */
+type PutCharactersCharacterIdContactsContactId = number;

package/v2/put_characters_character_id_mail_mail_id_contents.d.ts

@@ -0,0 +1,27 @@
+/**
+ * ESI endpoint: /characters/{character_id}/mail/{mail_id}/
+ */
+
+/**
+ * label integer
+ */
+type PutCharactersCharacterIdMailMailIdLabel = number;
+/**
+ * Labels to assign to the mail. Pre-existing labels are unassigned.
+ *
+ * @maxItems 25
+ */
+type PutCharactersCharacterIdMailMailIdLabels = PutCharactersCharacterIdMailMailIdLabel[];
+/**
+ * Whether the mail is flagged as read
+ */
+type PutCharactersCharacterIdMailMailIdRead = boolean;
+
+/**
+ * contents object
+ */
+interface PutCharactersCharacterIdMailMailIdContents {
+  labels?: PutCharactersCharacterIdMailMailIdLabels;
+  read?: PutCharactersCharacterIdMailMailIdRead;
+  [k: string]: unknown | undefined;
+}

package/v2/put_fleets_fleet_id_members_member_id_movement.d.ts

@@ -0,0 +1,30 @@
+/**
+ * ESI endpoint: /fleets/{fleet_id}/members/{member_id}/
+ */
+
+/**
+ * If a character is moved to the `fleet_commander` role, neither `wing_id` or `squad_id` should be specified. If a character is moved to the `wing_commander` role, only `wing_id` should be specified. If a character is moved to the `squad_commander` role, both `wing_id` and `squad_id` should be specified. If a character is moved to the `squad_member` role, both `wing_id` and `squad_id` should be specified.
+ */
+type PutFleetsFleetIdMembersMemberIdRole =
+  | "fleet_commander"
+  | "wing_commander"
+  | "squad_commander"
+  | "squad_member";
+/**
+ * squad_id integer
+ */
+type PutFleetsFleetIdMembersMemberIdSquadId = number;
+/**
+ * wing_id integer
+ */
+type PutFleetsFleetIdMembersMemberIdWingId = number;
+
+/**
+ * movement object
+ */
+interface PutFleetsFleetIdMembersMemberIdMovement {
+  role: PutFleetsFleetIdMembersMemberIdRole;
+  squad_id?: PutFleetsFleetIdMembersMemberIdSquadId;
+  wing_id?: PutFleetsFleetIdMembersMemberIdWingId;
+  [k: string]: unknown | undefined;
+}

package/v2/put_fleets_fleet_id_new_settings.d.ts

@@ -0,0 +1,21 @@
+/**
+ * ESI endpoint: /fleets/{fleet_id}/
+ */
+
+/**
+ * Should free-move be enabled in the fleet
+ */
+type PutFleetsFleetIdIsFreeMove = boolean;
+/**
+ * New fleet MOTD in CCP flavoured HTML
+ */
+type PutFleetsFleetIdMotd = string;
+
+/**
+ * new_settings object
+ */
+interface PutFleetsFleetIdNewSettings {
+  is_free_move?: PutFleetsFleetIdIsFreeMove;
+  motd?: PutFleetsFleetIdMotd;
+  [k: string]: unknown | undefined;
+}

package/v2/put_fleets_fleet_id_squads_squad_id_naming.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ESI endpoint: /fleets/{fleet_id}/squads/{squad_id}/
+ */
+
+/**
+ * name string
+ */
+type PutFleetsFleetIdSquadsSquadIdName = string;
+
+/**
+ * naming object
+ */
+interface PutFleetsFleetIdSquadsSquadIdNaming {
+  name: PutFleetsFleetIdSquadsSquadIdName;
+  [k: string]: unknown | undefined;
+}

package/v2/put_fleets_fleet_id_wings_wing_id_naming.d.ts

@@ -0,0 +1,16 @@
+/**
+ * ESI endpoint: /fleets/{fleet_id}/wings/{wing_id}/
+ */
+
+/**
+ * name string
+ */
+type PutFleetsFleetIdWingsWingIdName = string;
+
+/**
+ * naming object
+ */
+interface PutFleetsFleetIdWingsWingIdNaming {
+  name: PutFleetsFleetIdWingsWingIdName;
+  [k: string]: unknown | undefined;
+}

package/v2.mjs

@@ -0,0 +1,253 @@
+// import type { TESIResponseOKMap } from "eve-esi-types";
+// - - - - - - - - - - - - - - - - - - - -
+//           constants, types
+// - - - - - - - - - - - - - - - - - - - -
+// shorthands
+const log = console.log;
+const isArray = Array.isArray;
+/**
+ * enable/disable console.log
+ */
+let LOG = false;
+/**
+ * this always `https://esi.evetech.net`
+ */
+const BASE = "https://esi.evetech.net";
+/**
+ * @typedef {import("./v2").TESIResponseOKMap} TESIResponseOKMap
+ */
+/**
+ * @typedef ESIRequestOptions
+ * @prop {Record<string, any>} [queries] query params for ESI request.
+ * @prop {any} [body] will need it for `POST` request etc.
+ * @prop {boolean} [ignoreError]  if want response data with ignore error then can be set to `true`.
+ * @prop {AbortController} [cancelable] cancel request immediately
+ * @prop {string} [token] Can be an empty object if no authentication is required.description
+ * @prop {true=} [auth] Can be an empty object if no authentication is required.description
+ */
+// - - - - - - - - - - - - - - - - - - - -
+//        module vars, functions
+// - - - - - - - - - - - - - - - - - - - -
+/**
+ * Get the number of currently executing ESI requests
+ */
+let ax = 0;
+/**
+ * simple named error class.
+ */
+class ESIRequesError extends Error {
+}
+/**
+ * throws when x-esi-error-limit-remain header value is "0". (http status: 420)
+ */
+class ESIErrorLimitReachedError extends Error {
+    constructor() {
+        super("Cannot continue ESI request because 'x-esi-error-limit-remain' is zero!");
+    }
+    valueOf() {
+        return 420;
+    }
+}
+/**
+ * fetch the extra pages
+ *
+ *   + if the `x-pages` header property ware more than 1
+ *
+ * @param {string} endpointUrl
+ * @param {RequestInit} rqopt request options
+ * @param {Record<string, any>} qs queries
+ * @param {number} pc pageCount
+ */
+const fetchP = async (endpointUrl, rqopt, qs, pc) => {
+    const rqs = [];
+    const rqp = new URLSearchParams(qs);
+    for (let i = 2; i <= pc;) {
+        rqp.set("page", (i++) + "");
+        ax++;
+        rqs.push(fetch(`${endpointUrl}?${rqp + ""}`, rqopt).then(res => res.json()).catch(reason => {
+            console.warn(reason);
+            return [];
+        }).finally(() => {
+            ax--;
+        }));
+    }
+    return Promise.all(rqs).then(jsons => {
+        // DEVNOTE: let check the page 2, type is array?
+        if (isArray(jsons[0])) {
+            let combined = [];
+            for (let i = 0, end = jsons.length; i < end;) {
+                combined = combined.concat(jsons[i++]);
+            }
+            return combined;
+        }
+        LOG && log("> > > pages result are object < < < --", jsons);
+        return null;
+    });
+};
+/** ### replace (C)urly (B)races (T)oken
+ *
+ * @example
+ * "/characters/{character_id}/skills"
+ * // ->
+ * "/characters/<char.character_id>/skills"
+ *
+ * @param {string} endpoint e.g - "/characters/{character_id}/"
+ * @param {number[]} ids
+ * @returns fragment of qualified endpoint uri or null.
+ */
+const replaceCbt = (endpoint, ids) => {
+    const re = /{([\w]+)}/g;
+    /** @type {RegExpExecArray?} */
+    let m;
+    let idx = 0;
+    while (m = re.exec(endpoint)) {
+        endpoint = endpoint.replace(m[0], ids[idx++] + "");
+    }
+    return endpoint;
+};
+/**
+ *
+ * @param {string} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
+ *   + The version parameter can be omitted by using `<version>/<endpoint>`
+ */
+const curl = (endp) => {
+    endp = endp.replace(/^\/+|\/+$/g, "");
+    return `${BASE}/latest/${endp}/`;
+};
+// - - - - - - - - - - - - - - - - - - - -
+//            main functions
+// - - - - - - - - - - - - - - - - - - - -
+// It should complete correctly.
+async function getEVEStatus() {
+    try {
+        const ok = await fire("get", "/characters/{character_id}/ship/", 994562, { auth: true, token: "<accessToken of 994562>" });
+    }
+    catch (error) {
+        console.error("Failed to get character ship -", error);
+    }
+    return fire("get", "/status/");
+}
+/**
+ * fire ESI request
+ * @template {TESIEntryMethod} M
+ * @template {keyof TESIResponseOKMap[M]} EP
+ * @template {IdentifyParameters<TESIResponseOKMap[M][EP] & { result: any }, ESIRequestOptions>} Opt
+ * @template {TESIResponseOKMap[M][EP] extends { result: infer U } ? U : never} R
+ *
+ * @param {M} mthd
+ * @param {EP} endp - The endpoint to request.
+ * @param {number | number[] | Opt} [pathParams] - Optional path parameters.
+ * @param {Opt} [opt] - default is empty object {}. `body` is json string
+ * @returns {Promise<R>} - The response from the endpoint.
+ * @throws
+ * @async
+ */
+export async function fire(mthd, endp, pathParams, opt) {
+    if (typeof pathParams === "number") {
+        pathParams = /** @type {number[]} */ ([pathParams]);
+    }
+    if (isArray(pathParams)) {
+        // @ts-ignore actualy endp is string
+        endp = replaceCbt(endp, pathParams);
+    }
+    if (!opt) {
+        // When only options are provided
+        opt = /** @type {Opt} */ (pathParams) || opt || {};
+    }
+    /** @type {RequestInit} */
+    const rqopt = {
+        method: mthd,
+        mode: "cors",
+        cache: "no-cache",
+        signal: opt.cancelable?.signal,
+        headers: {}
+    };
+    const qss = {
+    // language: "en",
+    };
+    if (opt.queries) {
+        // Object.assign(queries, options.queries); Object.assign is too slow
+        const oqs = opt.queries;
+        for (const k of Object.keys(oqs)) {
+            qss[k] = oqs[k];
+        }
+    }
+    // DEVNOTE: when datasource is not empty string. (e.g - "singularity"
+    // in this case must specify datasource.
+    // disabled since `REMOVING DATASOURCE SINGULARITY`
+    // if (opt.datasource === "singularity") {
+    //     opt.datasource = "tranquility";
+    // }
+    if (opt.auth) {
+        // @ts-ignore The header is indeed an object
+        rqopt.headers.authorization = `Bearer ${opt.token}`;
+    }
+    if (opt.body) { // means "POST" method etc
+        // @ts-ignore The header is indeed an object
+        rqopt.headers["content-type"] = "application/json";
+        rqopt.body = JSON.stringify(opt.body);
+    }
+    // @ts-ignore actualy endp is string
+    const endpointUrl = curl(endp);
+    ax++;
+    try {
+        // @ts-ignore A silly type error will appear, but ignore it.
+        const res = await fetch(`${endpointUrl}?${new URLSearchParams(qss) + ""}`, rqopt).finally(() => {
+            ax--;
+        });
+        const stat = res.status;
+        if (!res.ok && !opt.ignoreError) {
+            if (stat === 420) {
+                opt.cancelable && opt.cancelable.abort();
+                throw new ESIErrorLimitReachedError();
+            }
+            else {
+                // console.log(res);
+                throw new ESIRequesError(`${res.statusText} (status=${stat})`);
+            }
+        }
+        else {
+            // DEVNOTE: - 204 No Content
+            if (stat === 204) {
+                // this result is empty, decided to return status code.
+                return /** @type {R} */ ({ status: stat });
+            }
+            /** @type {R} */
+            const data = await res.json();
+            if (opt.ignoreError) {
+                // meaning `forceJson`?
+                return data;
+            }
+            // - - - - x-pages response.
+            // +undefined is NaN
+            // @ts-ignore becouse +null is 0
+            const pc = +res.headers.get("x-pages");
+            // has remaining pages? NaN > 1 === false !isNaN(pageCount)
+            if (pc > 1) {
+                LOG && log('found "x-pages" header, pages: %d', pc);
+                const remData = await fetchP(endpointUrl, rqopt, qss, pc);
+                // finally, decide product data.
+                if (isArray(data) && isArray(remData)) {
+                    // DEVNOTE: 2019/7/23 15:01:48 - types
+                    return /** @type {R} */ (data.concat(remData));
+                }
+                else {
+                    // @ts-ignore TODO: fix type
+                    remData && Object.assign(data, remData);
+                }
+            }
+            return data;
+        }
+    }
+    catch (e) {
+        // @ts-ignore actualy endp is string
+        throw new ESIRequesError(`message: ${e.message}, endpoint=${endp}`);
+    }
+}
+// node v2.mjs
+getEVEStatus().then(eveStatus => console.log(eveStatus));
+// {
+//     "players": 16503,
+//     "server_version": "2794925",
+//     "start_time": "2025-01-21T11:02:34Z"
+// }