eve-esi-types 2.0.5-beta → 2.1.0

package/v2/index.d.ts

@@ -194,6 +194,7 @@ import "./get_universe_types_type_id_ok.d.ts";
 import "./get_wars_ok.d.ts";
 import "./get_wars_war_id_ok.d.ts";
 import "./get_wars_war_id_killmails_ok.d.ts";
+import "./extra-types.d.ts";
 
 
 /**
@@ -207,6 +208,19 @@ type RequireThese<T, K extends keyof T> = T & Required<Pick<T, K>>;
 
 declare global {
 
+  /**
+   * is parameterized path
+   */
+  type IsParameterizedPath<EP, A, B> = EP extends `${string}/{${string}}/${string | ""}` ? A: B;
+  /**
+   * Identifies the required parameters for a given entry type.
+   *
+   * @template Entry - The entry type to identify parameters for.
+   * @template Opt - The type of the parameters.
+   * @type {Opt & Pick<Entry, Exclude<keyof Entry, "result">>}
+   */
+  type IdentifyParameters<Entry, Opt> = Opt & Pick<Entry, Exclude<keyof Entry, "result">>;
+
   /**
    * Infer the result type of an ESI response based on the method and endpoint.
    * 
@@ -218,21 +232,6 @@ declare global {
     EP extends keyof TESIResponseOKMap[M]
   > = TESIResponseOKMap[M][EP] extends { result: infer U } ? U : never;
 
-  /**
-   * Identifies the required parameters for a given entry type.
-   *
-   * @template Entry - The entry type to identify parameters for.
-   * @template T - The type of the parameters.
-   * @template Auth - Determines if the "auth" parameter is required. Defaults to `never` if "auth" is not a key in Entry or if "auth" is undefined.
-   * @template Body - Determines if the "body" parameter is required. Defaults to `never` if "body" is not a key in Entry or if "body" is undefined.
-   * @type RequireThese<T, Extract<Auth | Body, keyof T>>
-   */
-  type IdentifyParameters<
-    Entry, T,
-    Auth = "auth" extends keyof Entry ? (undefined extends Entry["auth"] ? never : "auth") : never,
-    Body = "body" extends keyof Entry ? (undefined extends Entry["body"] ? never : "body") : never,
-  > = RequireThese<T, Extract<Auth | Body, keyof T>>;
-
   /**
    * Represents a response with no content (HTTP status 204).
    * Although no data is returned, it indicates successful completion by returning a status of 204.
@@ -342,8 +341,10 @@ export type TESIResponseOKMap = {
     },
     "/characters/{character_id}/calendar/": {
       result: GetCharactersCharacterIdCalendarOk;
+      query: {
+        from_event?: number;
+      },
       auth: true;
-      query: true;
     },
     "/characters/{character_id}/calendar/{event_id}/": {
       result: GetCharactersCharacterIdCalendarEventIdOk;
@@ -402,8 +403,10 @@ export type TESIResponseOKMap = {
     },
     "/characters/{character_id}/industry/jobs/": {
       result: GetCharactersCharacterIdIndustryJobsOk;
+      query: {
+        include_completed?: boolean;
+      },
       auth: true;
-      query: true;
     },
     "/characters/{character_id}/killmails/recent/": {
       result: GetCharactersCharacterIdKillmailsRecentOk;
@@ -419,8 +422,11 @@ export type TESIResponseOKMap = {
     },
     "/characters/{character_id}/mail/": {
       result: GetCharactersCharacterIdMailOk;
+      query: {
+        labels?: GetCharactersCharacterIdMailLabels;
+        last_mail_id?: number;
+      },
       auth: true;
-      query: true;
     },
     "/characters/{character_id}/mail/labels/": {
       result: GetCharactersCharacterIdMailLabelsOk;
@@ -483,8 +489,12 @@ export type TESIResponseOKMap = {
     },
     "/characters/{character_id}/search/": {
       result: GetCharactersCharacterIdSearchOk;
+      query: {
+        categories: GetCharactersCharacterIdSearchCategories;
+        search: GetCharactersCharacterIdSearchSearch;
+        strict?: boolean;
+      },
       auth: true;
-      query: true;
     },
     "/characters/{character_id}/ship/": {
       result: GetCharactersCharacterIdShipOk;
@@ -516,8 +526,10 @@ export type TESIResponseOKMap = {
     },
     "/characters/{character_id}/wallet/transactions/": {
       result: GetCharactersCharacterIdWalletTransactionsOk;
+      query: {
+        from_id?: number;
+      },
       auth: true;
-      query: true;
     },
     "/contracts/public/bids/{contract_id}/": {
       result: GetContractsPublicBidsContractIdOk;
@@ -610,8 +622,10 @@ export type TESIResponseOKMap = {
     },
     "/corporations/{corporation_id}/industry/jobs/": {
       result: GetCorporationsCorporationIdIndustryJobsOk;
+      query: {
+        include_completed?: boolean;
+      },
       auth: true;
-      query: true;
     },
     "/corporations/{corporation_id}/killmails/recent/": {
       result: GetCorporationsCorporationIdKillmailsRecentOk;
@@ -671,8 +685,10 @@ export type TESIResponseOKMap = {
     },
     "/corporations/{corporation_id}/starbases/{starbase_id}/": {
       result: GetCorporationsCorporationIdStarbasesStarbaseIdOk;
+      query: {
+        system_id: number;
+      },
       auth: true;
-      query: true;
     },
     "/corporations/{corporation_id}/structures/": {
       result: GetCorporationsCorporationIdStructuresOk;
@@ -692,8 +708,10 @@ export type TESIResponseOKMap = {
     },
     "/corporations/{corporation_id}/wallets/{division}/transactions/": {
       result: GetCorporationsCorporationIdWalletsDivisionTransactionsOk;
+      query: {
+        from_id?: number;
+      },
       auth: true;
-      query: true;
     },
     "/dogma/attributes/": {
       result: GetDogmaAttributesOk;
@@ -773,11 +791,16 @@ export type TESIResponseOKMap = {
     },
     "/markets/{region_id}/history/": {
       result: GetMarketsRegionIdHistoryOk;
-      query: true;
+      query: {
+        type_id: number;
+      }
     },
     "/markets/{region_id}/orders/": {
       result: GetMarketsRegionIdOrdersOk;
-      query: true;
+      query: {
+        order_type: GetMarketsRegionIdOrdersOrderType;
+        type_id?: number;
+      }
     },
     "/markets/{region_id}/types/": {
       result: GetMarketsRegionIdTypesOk;
@@ -796,7 +819,11 @@ export type TESIResponseOKMap = {
     },
     "/route/{origin}/{destination}/": {
       result: GetRouteOriginDestinationOk;
-      query: true;
+      query: {
+        avoid?: GetRouteOriginDestinationAvoid;
+        connections?: GetRouteOriginDestinationConnections;
+        flag?: GetRouteOriginDestinationFlag;
+      }
     },
     "/sovereignty/campaigns/": {
       result: GetSovereigntyCampaignsOk;
@@ -875,7 +902,9 @@ export type TESIResponseOKMap = {
     },
     "/universe/structures/": {
       result: GetUniverseStructuresOk;
-      query: true;
+      query: {
+        filter?: GetUniverseStructuresFilter;
+      }
     },
     "/universe/structures/{structure_id}/": {
       result: GetUniverseStructuresStructureIdOk;
@@ -901,7 +930,9 @@ export type TESIResponseOKMap = {
     },
     "/wars/": {
       result: GetWarsOk;
-      query: true;
+      query: {
+        max_war_id?: number;
+      }
     },
     "/wars/{war_id}/": {
       result: GetWarsWarIdOk;
@@ -914,77 +945,91 @@ export type TESIResponseOKMap = {
     "/ui/autopilot/waypoint/": {
       result: NoContentResponse;
       auth: true;
-      query: true;
+      query: {
+        add_to_beginning: boolean;
+        clear_other_waypoints: boolean;
+        destination_id: number;
+      }
     },
     "/ui/openwindow/contract/": {
       result: NoContentResponse;
       auth: true;
-      query: true;
+      query: {
+        contract_id: number;
+      }
     },
     "/ui/openwindow/information/": {
       result: NoContentResponse;
       auth: true;
-      query: true;
+      query: {
+        target_id: number;
+      }
     },
     "/ui/openwindow/marketdetails/": {
       result: NoContentResponse;
       auth: true;
-      query: true;
+      query: {
+        type_id: number;
+      }
     },
     "/characters/affiliation/": {
       result: PostCharactersAffiliationOk;
-      body: true;
+      body: PostCharactersAffiliationCharacters;
     },
     "/characters/{character_id}/assets/locations/": {
       result: PostCharactersCharacterIdAssetsLocationsOk;
+      body: PostCharactersCharacterIdAssetsLocationsItemIds;
       auth: true;
-      body: true;
     },
     "/characters/{character_id}/assets/names/": {
       result: PostCharactersCharacterIdAssetsNamesOk;
+      body: PostCharactersCharacterIdAssetsNamesItemIds;
       auth: true;
-      body: true;
     },
     "/characters/{character_id}/contacts/": {
       result: PostCharactersCharacterIdContactsCreated;
+      body: PostCharactersCharacterIdContactsContactIds;
+      query: {
+        label_ids?: PostCharactersCharacterIdContactsLabelIds;
+        standing: number;
+        watched?: boolean;
+      },
       auth: true;
-      body: true;
-      query: true;
     },
     "/characters/{character_id}/cspa/": {
       result: PostCharactersCharacterIdCspaCreated;
+      body: PostCharactersCharacterIdCspaCharacters;
       auth: true;
-      body: true;
     },
     "/characters/{character_id}/fittings/": {
       result: PostCharactersCharacterIdFittingsCreated;
+      body: PostCharactersCharacterIdFittingsFitting;
       auth: true;
-      body: true;
     },
     "/characters/{character_id}/mail/": {
       result: PostCharactersCharacterIdMailCreated;
+      body: PostCharactersCharacterIdMailMail;
       auth: true;
-      body: true;
     },
     "/characters/{character_id}/mail/labels/": {
       result: PostCharactersCharacterIdMailLabelsCreated;
+      body: PostCharactersCharacterIdMailLabelsLabel;
       auth: true;
-      body: true;
     },
     "/corporations/{corporation_id}/assets/locations/": {
       result: PostCorporationsCorporationIdAssetsLocationsOk;
+      body: PostCorporationsCorporationIdAssetsLocationsItemIds;
       auth: true;
-      body: true;
     },
     "/corporations/{corporation_id}/assets/names/": {
       result: PostCorporationsCorporationIdAssetsNamesOk;
+      body: PostCorporationsCorporationIdAssetsNamesItemIds;
       auth: true;
-      body: true;
     },
     "/fleets/{fleet_id}/members/": {
       result: PostFleetsFleetIdMembersInvitation;
+      body: PostFleetsFleetIdMembersInvitation;
       auth: true;
-      body: true;
     },
     "/fleets/{fleet_id}/wings/": {
       result: PostFleetsFleetIdWingsCreated;
@@ -996,61 +1041,67 @@ export type TESIResponseOKMap = {
     },
     "/ui/openwindow/newmail/": {
       result: PostUiOpenwindowNewmailNewMail;
+      body: PostUiOpenwindowNewmailNewMail;
       auth: true;
-      body: true;
     },
     "/universe/ids/": {
       result: PostUniverseIdsOk;
-      body: true;
+      body: PostUniverseIdsNames;
     },
     "/universe/names/": {
       result: PostUniverseNamesOk;
-      body: true;
+      body: PostUniverseNamesIds;
     }
   },
   put: {
     "/characters/{character_id}/calendar/{event_id}/": {
       result: PutCharactersCharacterIdCalendarEventIdResponse;
+      body: PutCharactersCharacterIdCalendarEventIdResponse;
       auth: true;
-      body: true;
     },
     "/characters/{character_id}/contacts/": {
       result: PutCharactersCharacterIdContactsContactIds;
+      body: PutCharactersCharacterIdContactsContactIds;
+      query: {
+        label_ids?: PutCharactersCharacterIdContactsLabelIds;
+        standing: number;
+        watched?: boolean;
+      },
       auth: true;
-      body: true;
-      query: true;
     },
     "/characters/{character_id}/mail/{mail_id}/": {
       result: PutCharactersCharacterIdMailMailIdContents;
+      body: PutCharactersCharacterIdMailMailIdContents;
       auth: true;
-      body: true;
     },
     "/fleets/{fleet_id}/": {
       result: PutFleetsFleetIdNewSettings;
+      body: PutFleetsFleetIdNewSettings;
       auth: true;
-      body: true;
     },
     "/fleets/{fleet_id}/members/{member_id}/": {
       result: PutFleetsFleetIdMembersMemberIdMovement;
+      body: PutFleetsFleetIdMembersMemberIdMovement;
       auth: true;
-      body: true;
     },
     "/fleets/{fleet_id}/squads/{squad_id}/": {
       result: PutFleetsFleetIdSquadsSquadIdNaming;
+      body: PutFleetsFleetIdSquadsSquadIdNaming;
       auth: true;
-      body: true;
     },
     "/fleets/{fleet_id}/wings/{wing_id}/": {
       result: PutFleetsFleetIdWingsWingIdNaming;
+      body: PutFleetsFleetIdWingsWingIdNaming;
       auth: true;
-      body: true;
     }
   },
   delete: {
     "/characters/{character_id}/contacts/": {
       result: NoContentResponse;
       auth: true;
-      query: true;
+      query: {
+        contact_ids: DeleteCharactersCharacterIdContactsContactIds;
+      }
     },
     "/characters/{character_id}/fittings/{fitting_id}/": {
       result: NoContentResponse;

package/v2.mjs

@@ -18,12 +18,12 @@ const BASE = "https://esi.evetech.net";
  */
 /**
  * @typedef ESIRequestOptions
- * @prop {Record<string, any>} [queries] query params for ESI request.
+ * @prop {Record<string, any>} [query] query params for ESI request.
  * @prop {any} [body] will need it for `POST` request etc.
+ * @prop {true=} [auth] Can be an empty object if no authentication is required.description
+ * @prop {string} [token] Can be an empty object if no authentication is required.description
  * @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
@@ -120,7 +120,27 @@ const curl = (endp) => {
 // It should complete correctly.
 async function getEVEStatus() {
     try {
-        const ok = await fire("get", "/characters/{character_id}/ship/", 994562, { auth: true, token: "<accessToken of 994562>" });
+        const ok = await fire("get", "/characters/{character_id}/ship/", 994562, { auth: true });
+        // query patameter `filter` is optional
+        await fire("get", "/universe/structures/", {
+            query: {
+            // filter: "market"
+            }
+        });
+        // in this case, "categories" and "search" is required
+        await fire("get", "/characters/{character_id}/search/", 994562, {
+            query: {
+                categories: ["agent"],
+                search: "ok"
+            },
+            auth: true
+        });
+        // in this case, "order_type" is required
+        await fire("get", "/markets/{region_id}/orders/", 994562, {
+            query: {
+                order_type: "all"
+            },
+        });
         console.log(ok);
     }
     catch (error) {
@@ -132,43 +152,46 @@ async function getEVEStatus() {
  * fire ESI request
  * @template {TESIEntryMethod} M
  * @template {keyof TESIResponseOKMap[M]} EP
+ * @template {IsParameterizedPath<EP, number | number[], Opt>} P2
  * @template {IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>} Opt
  * @template {InferESIResponseResult<M, EP>} R
  *
  * @param {M} mthd
  * @param {EP} endp - The endpoint to request.
- * @param {number | number[] | Opt} [pathParams] - Optional path parameters.
+ * @param {P2} [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 = {}) {
+export async function fire(mthd, endp, pathParams, opt) {
     if (typeof pathParams === "number") {
-        pathParams = /** @type {number[]} */ ([pathParams]);
+        // @ts-ignore 
+        pathParams = [pathParams];
     }
     if (isArray(pathParams)) {
         // @ts-ignore actualy endp is string
         endp = replaceCbt(endp, pathParams);
     }
     // When only options are provided
-    // @ts- ignore 
-    opt = /** @type {Opt} */ (pathParams) || opt || /** @type {Opt} */ ({});
+    /** @type {Opt} */
+    // @ts-ignore
+    const actualOpt = pathParams || opt || {};
     /** @type {RequestInit} */
     const rqopt = {
         method: mthd,
         mode: "cors",
         cache: "no-cache",
         // @ts-ignore 
-        signal: opt.cancelable?.signal,
+        signal: actualOpt.cancelable?.signal,
         headers: {}
     };
     const qss = {
         language: "en",
     };
-    if (opt.queries) {
+    if (actualOpt.query) {
         // Object.assign(queries, options.queries); Object.assign is too slow
-        const oqs = opt.queries;
+        const oqs = actualOpt.query;
         for (const k of Object.keys(oqs)) {
             qss[k] = oqs[k];
         }
@@ -176,17 +199,17 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
     // 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 (actualOpt.datasource === "singularity") {
+    //     actualOpt.datasource = "tranquility";
     // }
-    if (opt.auth) {
+    if (actualOpt.auth) {
         // @ts-ignore The header is indeed an object
-        rqopt.headers.authorization = `Bearer ${opt.token}`;
+        rqopt.headers.authorization = `Bearer ${actualOpt.token}`;
     }
-    if (opt.body) { // means "POST" method etc
+    if (actualOpt.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);
+        rqopt.body = JSON.stringify(actualOpt.body);
     }
     // @ts-ignore actualy endp is string
     const endpointUrl = curl(endp);
@@ -197,9 +220,9 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
             ax--;
         });
         const stat = res.status;
-        if (!res.ok && !opt.ignoreError) {
+        if (!res.ok && !actualOpt.ignoreError) {
             if (stat === 420) {
-                opt.cancelable && opt.cancelable.abort();
+                actualOpt.cancelable && actualOpt.cancelable.abort();
                 throw new ESIErrorLimitReachedError();
             }
             else {
@@ -215,7 +238,7 @@ export async function fire(mthd, endp, pathParams, opt = {}) {
             }
             /** @type {R} */
             const data = await res.json();
-            if (opt.ignoreError) {
+            if (actualOpt.ignoreError) {
                 // meaning `forceJson`?
                 return data;
             }