eve-esi-types 1.1.0 → 1.2.4

package/esi-request.d.mts

@@ -5,13 +5,12 @@
   https://opensource.org/licenses/mit-license.php
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-import type { TESIResponseOKMap } from "./src";
-type TRequestMethod = "get" | "post" | "put" | "delete";
+export type TRequestMethod = "get" | "post" | "put" | "delete";
 /**
  * __{Header}.{Payload}.{Signature}__
  */
-type TAcccessToken = `${string}.${string}.${string}`;
-type ESIRequestOptions = {
+export type TAcccessToken = `${string}.${string}.${string}`;
+export type ESIRequestOptions = {
     /**
      * query params for ESI request.
      */
@@ -35,24 +34,14 @@ type ESIRequestOptions = {
 };
 /**
  * fire ESI request
- * @template {"get" | "post" | "put" | "delete"} M
- * @template {keyof TESIResponseOKMap[M]} EP
- * @template {number | number[] | ESIRequestOptions} Opt
- * @template {TESIResponseOKMap[M][EP]} R
+ * @type {TESIRequestFunctionSignatureV1<ESIRequestOptions>}
  *
- * @param {M} mthd
- * @param {EP} endp - The endpoint to request.
- * @param {Opt} [pathParams] - Optional path parameters.
+ * @param method
+ * @param endpoint - The endpoint to request.
+ * @param [pathParams] - Optional path parameters.
  * @param {ESIRequestOptions} [opt] - default is empty object {}. `body` is json string
- * @returns {Promise<R>} - The response from the endpoint.
+ * @returns - The response from the endpoint.
  * @throws
  * @async
  */
-export declare function fire<
-    M extends TRequestMethod,
-    EP extends keyof TESIResponseOKMap[M],
-    Opt extends number | number[] | ESIRequestOptions,
-    R extends TESIResponseOKMap[M][EP]
->(
-    mthd: M, endp: EP, pathParams?: Opt, opt?: ESIRequestOptions
-): Promise<R>;
+export declare const fire: TESIRequestFunctionSignatureV1<ESIRequestOptions>;

package/esi-request.mjs

@@ -1,4 +1,14 @@
-// import type { TESIResponseOKMap } from "eve-esi-types";
+/*!
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
+  Released under the MIT license
+  https://opensource.org/licenses/mit-license.php
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/// <reference path="./src/index.d.ts"/>
+// - - - - - - - - - - - - - - - - - - - -
+//               imports
+// - - - - - - - - - - - - - - - - - - - -
 // - - - - - - - - - - - - - - - - - - - -
 //           constants, types
 // - - - - - - - - - - - - - - - - - - - -
@@ -16,6 +26,7 @@ const BASE = "https://esi.evetech.net";
 /**
  * @typedef {import("./src").TESIResponseOKMap} TESIResponseOKMap
  * @typedef {`${string}.${string}.${string}`} TAcccessToken __{Header}.{Payload}.{Signature}__
+ * @typedef {"get" | "post" | "put" | "delete"} TRequestMethod
  */
 /**
  * @typedef ESIRequestOptions
@@ -40,7 +51,7 @@ class ESIRequesError extends Error {
 /**
  * throws when x-esi-error-limit-remain header value is "0". (http status: 420)
  */
-class ESIErrorLimitReachedError extends Error {
+class ESIErrorLimitReachedError extends ESIRequesError {
     constructor() {
         super("Cannot continue ESI request because 'x-esi-error-limit-remain' is zero!");
     }
@@ -107,39 +118,62 @@ const replaceCbt = (endpoint, ids) => {
 };
 /**
  *
- * @param {string} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
+ * @param {string} endpoint 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}/`;
+const curl = (endpoint) => {
+    endpoint = endpoint.replace(/^\/+|\/+$/g, "");
+    return `${BASE}/latest/${endpoint}/`;
 };
 // - - - - - - - - - - - - - - - - - - - -
 //            main functions
 // - - - - - - - - - - - - - - - - - - - -
+/* ctt
 /**
  * fire ESI request
- * @template {"get" | "post" | "put" | "delete"} M
+ * @template {TRequestMethod} M
  * @template {keyof TESIResponseOKMap[M]} EP
- * @template {number | number[] | ESIRequestOptions} Opt
+ * @template {IfParameterizedPath<EP, ESIRequestOptions>} P2
  * @template {TESIResponseOKMap[M][EP]} R
  *
- * @param {M} mthd
- * @param {EP} endp - The endpoint to request.
- * @param {Opt} [pathParams] - Optional path parameters.
+ * @param {M} method
+ * @param {EP} endpoint - The endpoint to request.
+ * @param {P2} [pathParams] - Optional path parameters.
  * @param {ESIRequestOptions} [opt] - default is empty object {}. `body` is json string
  * @returns {Promise<R>} - The response from the endpoint.
  * @throws
  * @async
+ * /
+export async function fire<
+    M extends TRequestMethod,
+    EP extends keyof TESIResponseOKMap[M],
+    P2 extends IfParameterizedPath<EP, ESIRequestOptions>,
+    R extends TESIResponseOKMap[M][EP]
+>(
+    method: M, endpoint: EP, pathParams?: P2, opt: ESIRequestOptions = {}
+): Promise<R> {
+/*/
+/**
+ * fire ESI request
+ * @type {TESIRequestFunctionSignatureV1<ESIRequestOptions>}
+ *
+ * @param method
+ * @param endpoint - The endpoint to request.
+ * @param [pathParams] - Optional path parameters.
+ * @param {ESIRequestOptions} [opt] - default is empty object {}. `body` is json string
+ * @returns - The response from the endpoint.
+ * @throws
+ * @async
  */
-export async function fire(mthd, endp, pathParams, opt = {}) {
+export const fire = async (method, endpoint, pathParams, opt = {}) => {
+    //*/
     if (typeof pathParams === "number") {
         // @ts-expect-error 
         pathParams = [pathParams];
     }
     if (isArray(pathParams)) {
-        // @ts-ignore actualy endp is string
-        endp = replaceCbt(endp, pathParams);
+        // @ts-expect-error actualy endpoint is string
+        endpoint = replaceCbt(endpoint, pathParams);
     }
     else {
         // When only options are provided
@@ -147,21 +181,19 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
     }
     /** @type {RequestInit} */
     const rqopt = {
-        method: mthd,
+        method,
         mode: "cors",
         cache: "no-cache",
         signal: opt.cancelable?.signal,
         headers: {}
     };
     const qss = {
-    // language: "en",
+        language: "en"
     };
     if (opt.query) {
         // Object.assign(queries, options.queries); Object.assign is too slow
         const oqs = opt.query;
-        for (const k of Object.keys(oqs)) {
-            qss[k] = oqs[k];
-        }
+        Object.keys(oqs).forEach(k => qss[k] = oqs[k]);
     }
     // DEVNOTE: when datasource is not empty string. (e.g - "singularity"
     // in this case must specify datasource.
@@ -178,14 +210,12 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
         rqopt.headers["content-type"] = "application/json";
         rqopt.body = JSON.stringify(opt.body);
     }
-    // @ts-ignore actualy endp is string
-    const endpointUrl = curl(endp);
+    // @ts-ignore actualy endpoint is string
+    const endpointUrl = curl(endpoint);
     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 res = await fetch(`${endpointUrl}?${new URLSearchParams(qss) + ""}`, rqopt).finally(() => ax--);
         const stat = res.status;
         if (!res.ok && !opt.ignoreError) {
             if (stat === 420) {
@@ -193,17 +223,17 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
                 throw new ESIErrorLimitReachedError();
             }
             else {
-                // @ts-ignore actualy endp is string
-                throw new ESIRequesError(`maybe network disconneted or otherwise request data are invalid. (endpoint=${endp}, http status=${stat})`);
+                // @ts-ignore actualy endpoint is string
+                throw new ESIRequesError(`maybe network disconneted or otherwise request data are invalid. (endpoint=${endpoint}, http status=${stat})`);
             }
         }
         else {
             // DEVNOTE: - 204 No Content
             if (stat === 204) {
                 // this result is empty, decided to return status code.
-                return /** @type {R} */ ({ status: stat });
+                // @ts-ignore
+                return { status: stat };
             }
-            /** @type {R} */
             const data = await res.json();
             if (opt.ignoreError) {
                 // meaning `forceJson`?
@@ -220,7 +250,8 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
                 // finally, decide product data.
                 if (isArray(data) && isArray(remData)) {
                     // DEVNOTE: 2019/7/23 15:01:48 - types
-                    return /** @type {R} */ (data.concat(remData));
+                    // @ts-ignore 
+                    return data.concat(remData);
                 }
                 else {
                     // @ts-ignore TODO: fix type
@@ -231,10 +262,10 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
         }
     }
     catch (e) {
-        // @ts-ignore actualy endp is string
-        throw new ESIRequesError(`unknown error occurred, message: ${e.message}, endpoint=${endp}`);
+        // @ts-ignore actualy endpoint is string
+        throw new ESIRequesError(`unknown error occurred, message: ${e.message}, endpoint=${endpoint}`);
     }
-}
+};
 // It should complete correctly.
 async function getEVEStatus() {
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "1.1.0",
+  "version": "1.2.4",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 1 only)",
   "main": "src/index.d.ts",
   "scripts": {
@@ -12,8 +12,7 @@
   },
   "files": [
     "src",
-    "esi-request.mjs",
-    "esi-request.d.mts",
+    "esi-request.*",
     "LICENSE",
     "*.md",
     "package.json",
@@ -33,5 +32,8 @@
   "bugs": {
     "url": "https://github.com/jeffy-g/eve-esi-types/issues"
   },
-  "homepage": "https://github.com/jeffy-g/eve-esi-types#readme"
+  "homepage": "https://github.com/jeffy-g/eve-esi-types#readme",
+  "peerDependencies": {
+    "typescript": "latest"
+  }
 }

package/src/get_alliances_alliance_id_contacts_labels_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /alliances/{alliance_id}/contacts/labels/
+ * ESI endpoint: get:/alliances/{alliance_id}/contacts/labels/
  */
 /**
  * 200 ok array

package/src/get_alliances_alliance_id_contacts_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /alliances/{alliance_id}/contacts/
+ * ESI endpoint: get:/alliances/{alliance_id}/contacts/
  */
 /**
  * contact_type string

package/src/get_alliances_alliance_id_corporations_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /alliances/{alliance_id}/corporations/
+ * ESI endpoint: get:/alliances/{alliance_id}/corporations/
  */
 /**
  * 200 ok array

package/src/get_alliances_alliance_id_icons_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /alliances/{alliance_id}/icons/
+ * ESI endpoint: get:/alliances/{alliance_id}/icons/
  */
 
 /**

package/src/get_alliances_alliance_id_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /alliances/{alliance_id}/
+ * ESI endpoint: get:/alliances/{alliance_id}/
  */
 
 /**

package/src/get_alliances_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /alliances/
+ * ESI endpoint: get:/alliances/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_agents_research_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/agents_research/
+ * ESI endpoint: get:/characters/{character_id}/agents_research/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_assets_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/assets/
+ * ESI endpoint: get:/characters/{character_id}/assets/
  */
 /**
  * location_flag string

package/src/get_characters_character_id_attributes_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/attributes/
+ * ESI endpoint: get:/characters/{character_id}/attributes/
  */
 
 /**

package/src/get_characters_character_id_blueprints_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/blueprints/
+ * ESI endpoint: get:/characters/{character_id}/blueprints/
  */
 /**
  * Type of the location_id

package/src/get_characters_character_id_calendar_event_id_attendees_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/calendar/{event_id}/attendees/
+ * ESI endpoint: get:/characters/{character_id}/calendar/{event_id}/attendees/
  */
 /**
  * event_response string

package/src/get_characters_character_id_calendar_event_id_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/calendar/{event_id}/
+ * ESI endpoint: get:/characters/{character_id}/calendar/{event_id}/
  */
 /**
  * owner_type string

package/src/get_characters_character_id_calendar_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/calendar/
+ * ESI endpoint: get:/characters/{character_id}/calendar/
  */
 /**
  * event_response string

package/src/get_characters_character_id_clones_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/clones/
+ * ESI endpoint: get:/characters/{character_id}/clones/
  */
 /**
  * location_type string

package/src/get_characters_character_id_contacts_labels_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/contacts/labels/
+ * ESI endpoint: get:/characters/{character_id}/contacts/labels/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_contacts_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/contacts/
+ * ESI endpoint: get:/characters/{character_id}/contacts/
  */
 /**
  * contact_type string

package/src/get_characters_character_id_contracts_contract_id_bids_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/contracts/{contract_id}/bids/
+ * ESI endpoint: get:/characters/{character_id}/contracts/{contract_id}/bids/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_contracts_contract_id_items_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/contracts/{contract_id}/items/
+ * ESI endpoint: get:/characters/{character_id}/contracts/{contract_id}/items/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_contracts_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/contracts/
+ * ESI endpoint: get:/characters/{character_id}/contracts/
  */
 /**
  * To whom the contract is available

package/src/get_characters_character_id_corporationhistory_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/corporationhistory/
+ * ESI endpoint: get:/characters/{character_id}/corporationhistory/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_fatigue_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/fatigue/
+ * ESI endpoint: get:/characters/{character_id}/fatigue/
  */
 
 /**

package/src/get_characters_character_id_fittings_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/fittings/
+ * ESI endpoint: get:/characters/{character_id}/fittings/
  */
 /**
  * flag string

package/src/get_characters_character_id_fleet_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/fleet/
+ * ESI endpoint: get:/characters/{character_id}/fleet/
  */
 /**
  * Member’s role in fleet

package/src/get_characters_character_id_fw_stats_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/fw/stats/
+ * ESI endpoint: get:/characters/{character_id}/fw/stats/
  */
 
 /**

package/src/get_characters_character_id_implants_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/implants/
+ * ESI endpoint: get:/characters/{character_id}/implants/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_industry_jobs_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/industry/jobs/
+ * ESI endpoint: get:/characters/{character_id}/industry/jobs/
  */
 /**
  * status string

package/src/get_characters_character_id_killmails_recent_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/killmails/recent/
+ * ESI endpoint: get:/characters/{character_id}/killmails/recent/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_location_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/location/
+ * ESI endpoint: get:/characters/{character_id}/location/
  */
 
 /**

package/src/get_characters_character_id_loyalty_points_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/loyalty/points/
+ * ESI endpoint: get:/characters/{character_id}/loyalty/points/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_mail_labels_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/mail/labels/
+ * ESI endpoint: get:/characters/{character_id}/mail/labels/
  */
 /**
  * color string

package/src/get_characters_character_id_mail_lists_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/mail/lists/
+ * ESI endpoint: get:/characters/{character_id}/mail/lists/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_mail_mail_id_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/mail/{mail_id}/
+ * ESI endpoint: get:/characters/{character_id}/mail/{mail_id}/
  */
 /**
  * recipient_type string

package/src/get_characters_character_id_mail_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/mail/
+ * ESI endpoint: get:/characters/{character_id}/mail/
  */
 /**
  * recipient_type string

package/src/get_characters_character_id_medals_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/medals/
+ * ESI endpoint: get:/characters/{character_id}/medals/
  */
 /**
  * graphics array

package/src/get_characters_character_id_mining_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/mining/
+ * ESI endpoint: get:/characters/{character_id}/mining/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_notifications_contacts_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/notifications/contacts/
+ * ESI endpoint: get:/characters/{character_id}/notifications/contacts/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_notifications_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/notifications/
+ * ESI endpoint: get:/characters/{character_id}/notifications/
  */
 /**
  * sender_type string

package/src/get_characters_character_id_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/
+ * ESI endpoint: get:/characters/{character_id}/
  */
 /**
  * gender string

package/src/get_characters_character_id_online_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/online/
+ * ESI endpoint: get:/characters/{character_id}/online/
  */
 
 /**

package/src/get_characters_character_id_opportunities_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/opportunities/
+ * ESI endpoint: get:/characters/{character_id}/opportunities/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_orders_history_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/orders/history/
+ * ESI endpoint: get:/characters/{character_id}/orders/history/
  */
 /**
  * Valid order range, numbers are ranges in jumps

package/src/get_characters_character_id_orders_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/orders/
+ * ESI endpoint: get:/characters/{character_id}/orders/
  */
 /**
  * Valid order range, numbers are ranges in jumps

package/src/get_characters_character_id_planets_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/planets/
+ * ESI endpoint: get:/characters/{character_id}/planets/
  */
 /**
  * 200 ok array

package/src/get_characters_character_id_planets_planet_id_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/planets/{planet_id}/
+ * ESI endpoint: get:/characters/{character_id}/planets/{planet_id}/
  */
 /**
  * links array

package/src/get_characters_character_id_portrait_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/portrait/
+ * ESI endpoint: get:/characters/{character_id}/portrait/
  */
 
 /**