eve-esi-types 2.3.5 → 3.0.2

package/lib/tagged-request-api.mjs

@@ -9,9 +9,9 @@
 /**
  * @file eve-esi-types/lib/tagged-request-api.mts
  */
-import { request } from "./request-api.mjs";
+import { request2 } from "./request-api.mjs";
 /**
- * @import { TESIRequestFunctionMethods } from "../v2"
+ * @import { TESIRequestFunctionMethods2 } from "../v2"
  */
 /**
  * @typedef {`${string}${"" | `,${string}`}`} TMethodList
@@ -36,37 +36,36 @@ const ESITagMethodMapping = [
     "Wars:get"
 ];
 /**
- * `esi-tagged-types` and `injectESIRequestBody` allow for more intuitive use of ESI requests based on the "tags" defined in the EVE Swagger JSON.
- *
- * + The `ESI request API object` constructed by `injectESIRequestBody` lists narrowed endpoints by accessing the camel-cased "tags" members.
+ * Decorates the ESI request body into a tagged ESI request map.
  *
  * @example
  *    import * as taggedApi from "eve-esi-types/lib/tagged-request-api.mjs";
  *
- *    const esiRequest = taggedApi.injectESIRequestBody(...);
+ *    const esiRequest = taggedApi.decoreateESIRequestBody(...);
  *    const ret = await esiRequest.universe.get("/universe/structures/", { query: { filter: "market" }});
  *
  * @template {Record<string, unknown>} Opt - The options type for the request.
- * @param {TESIRequestFunctionSignature<Opt>} requestBody - The function signature for the ESI request.
- * @returns {XESI.TaggedESIRequestMap} - The tagged ESI request map.
- * @since 2.3
+ * @param {TESIRequestFunctionSignature2<Opt>} requestBody - The function signature for the ESI request.
+ * @returns {XESI.TaggedESIRequestMap2<Opt>} - The tagged ESI request map.
  */
-export function injectESIRequestBody(requestBody) {
-    const rq = /** @type {XESI.TaggedESIRequestMap<Opt>} */ ({});
+export function decoreateESIRequestBody(requestBody) {
+    const rq = /** @type {XESI.TaggedESIRequestMap2<Opt>} */ ({});
     // DEVNOTE: 2025/03/08 - In reality, you only need one function instance for each of "get", "post", "put", and "delete",
     // so you can just refer to the cached functions as a map.
-    const methodMap = /** @type {TESIRequestFunctionMethods<Opt>} */ ({});
+    const methodMap = /** @type {TESIRequestFunctionMethods2<Opt>} */ ({});
     /** @type {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
-        methodMap[method] = /** @type {TESIRequestFunctionEachMethod<typeof method, Opt>} */ ((e, params, opt) => requestBody(method, e, params, opt));
+        methodMap[method] = /** @type {TESIRequestFunctionEachMethod2<typeof method, Opt>} */ (
+        // @ts-expect-error Type peeling due to differences in inference process
+        (e, opt) => requestBody(method, e, opt));
     });
     for (const tagEntry of ESITagMethodMapping) {
         const [tag, methodList] = /** @type {[tag: XESI.ESITags, methods: TMethodList]} */ (tagEntry.split(":"));
         const methods = /** @type {TESIEntryMethod[]} */ (methodList.split(","));
-        const entry = /** @type {XESI.ESITaggedEndpointRequest<typeof tag, Opt>} */ ({});
+        const entry = /** @type {XESI.ESITaggedEndpointRequest2<typeof tag, Opt>} */ ({});
         for (const method of methods) {
             // However, from the point of view of type annotation, the parameters are different, so you need to cast it as `as type` instead of `satisfies`.
             // @ts-expect-error
-            entry[method] = /** @type {XESI.TaggedEndpointRequestFunction<typeof method, typeof tag, Opt>} */ (methodMap[method]);
+            entry[method] = /** @type {XESI.TaggedEndpointRequestFunction2<typeof method, typeof tag, Opt>} */ (methodMap[method]);
         }
         const camelCased = /** @type {XESI.LCamelCase<XESI.ESITags>} */ (tag[0].toLowerCase() + tag.slice(1).replace(/\s(.)/g, "$1"));
         rq[camelCased] = entry;
@@ -77,9 +76,9 @@ export function injectESIRequestBody(requestBody) {
  * @import { ESIRequestOptions } from "./rq-util.mjs";
  */
 /**
- * Injects the minimal implementation of ESI requests into `XESI.TaggedESIRequestMap`.
+ * Injects the minimal implementation of ESI requests into `XESI.TaggedESIRequestMap2`.
  *
- * @since 2.3
- * @type {XESI.TaggedESIRequestMap<ESIRequestOptions>}
+ * @since 2.x
+ * @type {XESI.TaggedESIRequestMap2<ESIRequestOptions>}
  */
-export const esi = injectESIRequestBody(request);
+export const esi = decoreateESIRequestBody(request2);

package/minimal-rq.mjs

@@ -10,55 +10,56 @@
 //               imports
 // - - - - - - - - - - - - - - - - - - - -
 import * as util from "./lib/rq-util.mjs";
-import { request } from "./lib/request-api.mjs";
+import { request2 } from "./lib/request-api.mjs";
 // - - - - - - - - - - - - - - - - - - - -
 //           constants, types
 // - - - - - - - - - - - - - - - - - - - -
 // shorthands
 const log = util.getUniversalLogger("[request-mini]: ");
 /**
- * @typedef {import("./v2").IESIRequestFunction<util.ESIRequestOptions>} IESIRequestFunction
- * @typedef {import("./v2").TESIRequestFunctionMethods<util.ESIRequestOptions>} TESIRequestFunctionMethods
+ * @typedef {import("./v2").IESIRequestFunction2<util.ESIRequestOptions>} IESIRequestFunction2
+ * @typedef {import("./v2").TESIRequestFunctionMethods2<util.ESIRequestOptions>} TESIRequestFunctionMethods2
  */
 // - - - - - - - - - - - - - - - - - - - -
 //            main functions
 // - - - - - - - - - - - - - - - - - - - -
 //
-// Delegates implementation to `request` (TESIRequestFunctionMethods)
+// Delegates implementation to `request` (TESIRequestFunctionMethods2)
 //
-const esiMethods = /** @type {TESIRequestFunctionMethods} */ ({});
+const esiMethods = /** @type {TESIRequestFunctionMethods2} */ ({});
 /** @type {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
-    esiMethods[method] = /** @type {TESIRequestFunctionEachMethod<typeof method>} */ (function (endpoint, params, opt) {
-        return request(method, endpoint, params, opt);
+    esiMethods[method] = /** @type {TESIRequestFunctionEachMethod2<typeof method>} */ (function (endpoint, opt) {
+        // @ts-expect-error
+        return request2(method, endpoint, opt);
     });
 });
 // It should complete correctly.
 /**
- * @param {IESIRequestFunction} fn
+ * @param {IESIRequestFunction2} fn
  */
-async function getEVEStatus(fn) {
+async function getEVEStatus2(fn) {
     await util.getSDEVersion().then(sdeVersion => log(`sdeVersion: ${sdeVersion}`.blue));
     await util.fireRequestsDoesNotRequireAuth(fn);
     CaseIESIRequestFunctionMethods: {
         await util.fireRequestsDoesNotRequireAuth(esiMethods);
     }
     const { clog, rlog } = util.getLogger();
-    CaseIESIRequestFunction: {
+    CaseIESIRequestFunction2: {
         const ID_CCP_Zoetrope = 2112625428;
         // - - - - - - - - - - - -
         //       Character
         // - - - - - - - - - - - -
         // Here, I borrow data from "CCP Zoetrope".
-        rlog("- - - - - - - > run as IESIRequestFunction<ESIRequestOptions>".red);
+        rlog("- - - - - - - > run as IESIRequestFunction2<ESIRequestOptions>".red);
         clog();
-        await fn.get("/characters/{character_id}/", ID_CCP_Zoetrope).then(log);
+        await fn.get("/characters/{character_id}/", { pathParams: ID_CCP_Zoetrope }).then(log);
         clog('(portrait)');
-        await fn.get("/characters/{character_id}/portrait/", ID_CCP_Zoetrope).then(log);
+        await fn.get(`/characters/${ID_CCP_Zoetrope}/portrait/`).then(log);
         clog('(affiliation)');
         const affiliation = await fn.post("/characters/affiliation/", { body: [ID_CCP_Zoetrope] });
         log(affiliation);
         clog('(corporation)');
-        await fn.get("/corporations/{corporation_id}/", affiliation[0].corporation_id).then(log);
+        await fn.get(`/corporations/${affiliation[0].corporation_id}/`).then(log);
         rlog("get:/incursions/".green);
         await fn.get("/incursions/").then(log);
         // - - - - - - - - - - - -
@@ -68,7 +69,8 @@ async function getEVEStatus(fn) {
         const ids = await fn.post("/universe/ids/", { body: ["the forge", "plex"] });
         log(ids.inventory_types, ids.regions);
         rlog(`get:/markets/${ids?.regions?.[0].id}/orders/?type_id=${ids?.inventory_types?.[0].id}, item PLEX`.green);
-        const orders = await fn.get("/markets/{region_id}/orders/", ids?.regions?.[0].id, {
+        const orders = await fn.get("/markets/{region_id}/orders/", {
+            pathParams: ids?.regions?.[0].id || 0,
             query: {
                 // page: 1,
                 order_type: "sell",
@@ -80,7 +82,7 @@ async function getEVEStatus(fn) {
     return fn.get("/status/");
 }
 const runTest = () => {
-    getEVEStatus(request).then(eveStatus => log(eveStatus));
+    getEVEStatus2(request2).then(eveStatus => log(eveStatus));
 };
 // type following and run
 // node minimal-rq.mjs -debug

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "2.3.5",
+  "version": "3.0.2",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
   "main": "v2/index.d.ts",
   "scripts": {

package/tagged-rq.mjs

@@ -5,19 +5,47 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
+/// <reference types="./v2"/>
 /**
  * @file tagged-rq.mts
- * @command node tagged-rq.mjs -x
+ * @command node tagged-rq.mjs -x -debug
  */
-import { esi as esiRq } from "./lib/tagged-request-api.mjs";
-// console.log(esiRq);
+import { esi } from "./lib/tagged-request-api.mjs";
+import * as util from "./lib/rq-util.mjs";
 // Furthermore, the endpoint selected is narrowed down by "tags" and "method".
-esiRq.character.get("/characters/{character_id}/", 2112625428).then(console.log);
-esiRq.universe.get("/universe/structures/", { query: { filter: "market" } }).then(console.log);
-esiRq.universe.post("/universe/ids/", {
+esi.alliance.get("/alliances/").then(aIds => {
+    console.log(`get:alliances, id size=${aIds.length}`);
+    // for (const aid of aIds.slice(0, 20)) {
+    //     esi.alliance.get(`/alliances/${aid}/`).then(console.log);
+    // }
+});
+esi.character.get("/characters/{character_id}/", { pathParams: 2112625428 }).then(console.log);
+esi.universe.post("/universe/ids/", {
     body: ["the forge", "plex"]
 }).then(console.log);
-esiRq.fittings.delete("/characters/{character_id}/fittings/{fitting_id}/", [1234, 56789]);
-esiRq.assets.get("/characters/{character_id}/assets/", 1234, {
-    auth: true
-}).then(console.log).catch(console.log);
+esi.universe.post("/universe/names/", {
+    body: [44992, 434243723, 109299958, 10000002]
+}).then(console.log);
+esi.universe.get("/universe/structures/", { query: { filter: "market" } }).then(console.log);
+// node tagged-rq.mjs -x -withError
+if (util.is("withError")) {
+    esi.assets.get("/characters/2112625428/assets/", {
+        auth: true
+    }).then(console.log).catch(console.log);
+    esi.mail.post("/characters/2112625428/mail/", /** @satisfies {Pick<TESIResponsePostEntry<"/characters/{character_id}/mail/">, "auth" | "body">} */ ({
+        auth: true,
+        body: {
+            subject: "test!!",
+            body: "",
+            recipients: [{
+                    recipient_id: 2112625428, recipient_type: "character"
+                }]
+        },
+        // token: "s.s.s"
+    })).then(console.log).catch(console.log);
+    esi.fittings.delete("/characters/{character_id}/fittings/{fitting_id}/", {
+        pathParams: [1234, 56789],
+        auth: true
+    });
+    esi.character.post("/characters/affiliation/").catch(console.log);
+}

package/v2/esi-tagged-types.d.ts

@@ -9,9 +9,9 @@
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/esi-tagged-types.d.ts
- * @summary This file is auto-generated and defines version 2.3.5 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.0.2 of the EVE Online ESI response types.
  */
-import { TESIResponseOKMap } from "./index.d.ts";
+import { TESIResponseOKMap, TPathParamsNever } from "./index.d.ts";
 export * from "./index.d.ts";
 
 /**
@@ -67,7 +67,7 @@ export declare type InferMethod<Tag> = InferSomethingBy<Tag>
 // type XPlanetary = InferMethod<"Planetary Interaction">;
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
-//    Utility Type `TaggedEndpointRequestFunction`
+//    Utility Type `TaggedEndpointRequestFunction2`
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
 /**
  * Creates a function type for making requests to tagged endpoints.
@@ -86,15 +86,19 @@ export declare type InferMethod<Tag> = InferSomethingBy<Tag>
  * @returns A promise that resolves to the response.
  * @date 2025/2/28
  */
-export declare type TaggedEndpointRequestFunction<M extends TESIEntryMethod, Tag extends ESITags, ActualOpt = {}> = <
-  EP extends SelectEndpointByTag<Tag, M>,
-  P2 extends IfParameterizedPath<EP, Opt>,
-  Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt>,
-  R extends InferESIResponseResult<M, EP>
->(endpoint: EP, pathParams?: P2, options?: Opt) => Promise<R>;
+export declare type TaggedEndpointRequestFunction2<M extends TESIEntryMethod, Tag extends ESITags, ActualOpt = {}> = <
+  RealEP extends ReplacePathParams<keyof TESIResponseOKMap[M] & string> | keyof TESIResponseOKMap[M],
+  EP extends InferEndpointOrigin<RealEP, SelectEndpointByTag<Tag, M>> extends never ? RealEP: InferEndpointOrigin<RealEP, SelectEndpointByTag<Tag, M>>,
+  PathParams extends RealEP extends EP ? IfNeedPathParams<EP>: TPathParamsNever,
+  Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt & PathParams>,
+  R extends InferESIResponseResult<M, EP>,
+  // RealEPX = ReplacePathParamsX<RealEPX>,
+  // EPX = ReplacePathParams<EP>,
+>(endpoint: RealEP, options?: Opt) => Promise<R>;
+
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
-//    Utility Type `ESITaggedEndpointRequest`
+//    Utility Type `ESITaggedEndpointRequest2`
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
 /**
  * Maps tags to their corresponding endpoint request functions.
@@ -102,9 +106,9 @@ export declare type TaggedEndpointRequestFunction<M extends TESIEntryMethod, Tag
  * @template Tag - The tag to map.
  * @date 2025/2/28
  */
-export declare type ESITaggedEndpointRequest<Tag extends ESITags, ActualOpt = {}> = {
+export declare type ESITaggedEndpointRequest2<Tag extends ESITags, ActualOpt = {}> = {
   [tag in Tag]: {
-    [method in InferMethod<Tag>]: TaggedEndpointRequestFunction<method, tag, ActualOpt>;
+    [method in InferMethod<Tag>]: TaggedEndpointRequestFunction2<method, tag, ActualOpt>;
   };
 }[Tag];
 
@@ -132,22 +136,22 @@ export declare type SelectEndpointByTag<
 
 /**
  * Maps lower camel case tags to their corresponding endpoint request functions.
- * @date 2025/2/28
+ * @date 2025/3/12
  */
-export declare type TaggedESIRequestMap<ActualOpt = {}> = {
-  [tag in ESITags as LCamelCase<tag>]: ESITaggedEndpointRequest<tag, ActualOpt>;
+export declare type TaggedESIRequestMap2<ActualOpt = {}> = {
+  [tag in ESITags as LCamelCase<tag>]: ESITaggedEndpointRequest2<tag, ActualOpt>;
 };
 
 /**
  * Creates a partial map of lower camel case tags to their corresponding endpoint request functions.
  * ```ts
  * // implements "factionWarfare", "wallet"
- * const esiRq: XTaggedESIRequestMapPartial<"factionWarfare" | "wallet">;
+ * const esiRq: TaggedESIRequestMapPartial2<"factionWarfare" | "wallet">;
  * ```
  * 
  * @template Props - The properties to require in the partial map.
  * @date 2025/2/28
  */
-export declare type TaggedESIRequestMapPartial<Props extends LCamelCase<ESITags>> = RequireThese<Partial<TaggedESIRequestMap>, Props>;
+export declare type TaggedESIRequestMapPartial2<Props extends LCamelCase<ESITags>> = RequireThese<Partial<TaggedESIRequestMap2>, Props>;
 
 export as namespace XESI;

package/v2/extra-types.d.ts

@@ -7,7 +7,7 @@
  * @minItems 1
  * @maxItems 1000
  */
-type PostCharactersAffiliationCharacters = number[];
+type PostCharactersAffiliationCharacters = [number, ...number[]];
 
 /* post_characters_character_id_assets_locations body type, name: item_ids */
 
@@ -17,7 +17,7 @@ type PostCharactersAffiliationCharacters = number[];
  * @minItems 1
  * @maxItems 1000
  */
-type PostCharactersCharacterIdAssetsLocationsItemIds = number[];
+type PostCharactersCharacterIdAssetsLocationsItemIds = [number, ...number[]];
 
 /* post_characters_character_id_assets_names body type, name: item_ids */
 
@@ -27,7 +27,7 @@ type PostCharactersCharacterIdAssetsLocationsItemIds = number[];
  * @minItems 1
  * @maxItems 1000
  */
-type PostCharactersCharacterIdAssetsNamesItemIds = number[];
+type PostCharactersCharacterIdAssetsNamesItemIds = [number, ...number[]];
 
 /* put_characters_character_id_calendar_event_id body type, name: response */
 
@@ -52,7 +52,7 @@ interface PutCharactersCharacterIdCalendarEventIdResponse {
  * @minItems 1
  * @maxItems 100
  */
-type PostCharactersCharacterIdContactsContactIds = number[];
+type PostCharactersCharacterIdContactsContactIds = [number, ...number[]];
 
 /* put_characters_character_id_contacts body type, name: contact_ids */
 
@@ -62,7 +62,7 @@ type PostCharactersCharacterIdContactsContactIds = number[];
  * @minItems 1
  * @maxItems 100
  */
-type PutCharactersCharacterIdContactsContactIds = number[];
+type PutCharactersCharacterIdContactsContactIds = [number, ...number[]];
 
 /* post_characters_character_id_cspa body type, name: characters */
 
@@ -72,7 +72,7 @@ type PutCharactersCharacterIdContactsContactIds = number[];
  * @minItems 1
  * @maxItems 100
  */
-type PostCharactersCharacterIdCspaCharacters = number[];
+type PostCharactersCharacterIdCspaCharacters = [number, ...number[]];
 
 /* post_characters_character_id_fittings body type, name: fitting */
 
@@ -82,7 +82,7 @@ type PostCharactersCharacterIdCspaCharacters = number[];
  * @minItems 1
  * @maxItems 512
  */
-type PostCharactersCharacterIdFittingsItems = PostCharactersCharacterIdFittingsItem[];
+type PostCharactersCharacterIdFittingsItems = [PostCharactersCharacterIdFittingsItem, ...PostCharactersCharacterIdFittingsItem[]];
 /**
  * Fitting location for the item. Entries placed in 'Invalid' will be discarded. If this leaves the fitting with nothing, it will cause an error.
  */
@@ -168,7 +168,7 @@ interface PostCharactersCharacterIdFittingsItem {
  * @minItems 1
  * @maxItems 50
  */
-type PostCharactersCharacterIdMailRecipients = PostCharactersCharacterIdMailRecipient[];
+type PostCharactersCharacterIdMailRecipients = [PostCharactersCharacterIdMailRecipient, ...PostCharactersCharacterIdMailRecipient[]];
 /**
  * recipient_type string
  */
@@ -270,7 +270,7 @@ interface PutCharactersCharacterIdMailMailIdContents {
  * @minItems 1
  * @maxItems 1000
  */
-type PostCorporationsCorporationIdAssetsLocationsItemIds = number[];
+type PostCorporationsCorporationIdAssetsLocationsItemIds = [number, ...number[]];
 
 /* post_corporations_corporation_id_assets_names body type, name: item_ids */
 
@@ -280,7 +280,7 @@ type PostCorporationsCorporationIdAssetsLocationsItemIds = number[];
  * @minItems 1
  * @maxItems 1000
  */
-type PostCorporationsCorporationIdAssetsNamesItemIds = number[];
+type PostCorporationsCorporationIdAssetsNamesItemIds = [number, ...number[]];
 
 /* put_fleets_fleet_id body type, name: new_settings */
 
@@ -390,7 +390,7 @@ interface PutFleetsFleetIdWingsWingIdNaming {
  * @minItems 1
  * @maxItems 50
  */
-type PostUiOpenwindowNewmailRecipients = number[];
+type PostUiOpenwindowNewmailRecipients = [number, ...number[]];
 
 /**
  * new_mail object
@@ -424,7 +424,7 @@ interface PostUiOpenwindowNewmailNewMail {
  * @minItems 1
  * @maxItems 500
  */
-type PostUniverseIdsNames = string[];
+type PostUniverseIdsNames = [string, ...string[]];
 
 /* post_universe_names body type, name: ids */
 
@@ -434,7 +434,7 @@ type PostUniverseIdsNames = string[];
  * @minItems 1
  * @maxItems 1000
  */
-type PostUniverseNamesIds = number[];
+type PostUniverseNamesIds = [number, ...number[]];
 
 
 /*! query types */
@@ -446,7 +446,7 @@ type PostUniverseNamesIds = number[];
  * @minItems 1
  * @maxItems 20
  */
-type DeleteCharactersCharacterIdContactsContactIds = number[];
+type DeleteCharactersCharacterIdContactsContactIds = [number, ...number[]];
 
 /* post_characters_character_id_contacts, label_ids query type */
 
@@ -497,7 +497,7 @@ type GetCharactersCharacterIdSearchCategory =
  * @minItems 1
  * @maxItems 11
  */
-type GetCharactersCharacterIdSearchCategories = GetCharactersCharacterIdSearchCategory[];
+type GetCharactersCharacterIdSearchCategories = [GetCharactersCharacterIdSearchCategory, ...GetCharactersCharacterIdSearchCategory[]];
 
 /* get_characters_character_id_search, search query type */