eve-esi-types 3.0.2 → 3.0.4

package/lib/request-api.mjs

@@ -69,8 +69,8 @@ export const request2 = /** @type {IESIRequestFunction2} */ (async (method, endp
 // implements rest methods of `request` (IESIRequestFunction2)
 //
 /** @type {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
-    request2[method] = /** @type {TESIRequestFunctionEachMethod2<typeof method>} */ (function (endpoint, opt) {
-        // @ts-expect-error TODO: 2025/3/12
-        return this(method, endpoint, opt);
+    request2[method] = /** @type {TESIRequestFunctionEachMethod2<typeof method, util.ESIRequestOptions>} */ ((endpoint, opt) => {
+        // @ts-expect-error TODO: ts(2345)
+        return request2(method, endpoint, opt);
     });
 });

package/lib/rq-util.d.mts

@@ -181,6 +181,9 @@ export declare function getLogger(): {
     clog: (...args: any[]) => void;
     rlog: (...args: any[]) => void;
 };
+export type TFireWithoutAuth = {
+    fireWithoutAuth<M extends TESIEntryMethod, RealEP extends ReplacePathParams<keyof TESIResponseOKMap[M] & string> | keyof TESIResponseOKMap[M], EP extends InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]> extends never ? RealEP : InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]>, PathParams extends RealEP extends EP ? IfNeedPathParams<EP> : TPathParamsNever, Opt extends IdentifyParameters<TESIResponseOKMap[M][Extract<EP, keyof TESIResponseOKMap[M]>], ESIRequestOptions & PathParams>, R extends InferESIResponseResult<M, Extract<EP, keyof TESIResponseOKMap[M]>>, HasOpt = HasRequireParams<TESIResponseOKMap[M][Extract<EP, keyof TESIResponseOKMap[M]>]> extends never ? 0 : 1>(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>, method: M, endpoint: RealEP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]): Promise<R>;
+}["fireWithoutAuth"];
 /**
  * Need typescript v5.5 later
  * @import * as ESI from "../v2";
@@ -189,12 +192,6 @@ export declare function getLogger(): {
  * @typedef {ESI.IESIRequestFunction2<ESIRequestOptions>} IESIRequestFunction2
  * @typedef {ESI.TESIRequestFunctionMethods2<ESIRequestOptions>} TESIRequestFunctionMethods2
  */
-/**
- * #### Fire a request that does not require authentication.
- *
- * @type {import("./rq-util.d.mts").fireWithoutAuth}
- */
-export declare function fireWithoutAuth<M extends TESIEntryMethod, RealEP extends ReplacePathParams<keyof TESIResponseOKMap[M] & string> | keyof TESIResponseOKMap[M], EP extends InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]> extends never ? RealEP : InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]>, PathParams extends RealEP extends EP ? IfNeedPathParams<EP> : TPathParamsNever, Opt extends IdentifyParameters<TESIResponseOKMap[M][Extract<EP, keyof TESIResponseOKMap[M]>], ESIRequestOptions & PathParams>, R extends InferESIResponseResult<M, Extract<EP, keyof TESIResponseOKMap[M]>>>(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>, method: M, endpoint: RealEP, opt?: Opt): Promise<R>;
 /**
  * #### Fire a request that does not require authentication.
  *

package/lib/rq-util.mjs

@@ -320,29 +320,28 @@ export function getLogger() {
     const rlog = consoleUtil.getLogger("- - -> Run ESI request".cyan);
     return { clog, rlog };
 }
-/**
- * Need typescript v5.5 later
- * @import * as ESI from "../v2";
- * @typedef {ESI.TESIResponseOKMap} TESIResponseOKMap
- * @typedef {ESI.TPathParamsNever} TPathParamsNever
- * @typedef {ESI.IESIRequestFunction2<ESIRequestOptions>} IESIRequestFunction2
- * @typedef {ESI.TESIRequestFunctionMethods2<ESIRequestOptions>} TESIRequestFunctionMethods2
- */
-// type ESIEndpointBrand<EP> = EP & { __esi: "x"; };
-// type EPPost = ESIEndpointBrand<keyof TESIResponseOKMap["post"]>;
 /**
  * #### Fire a request that does not require authentication.
  *
- * @type {import("./rq-util.d.mts").fireWithoutAuth}
+ * @type {import("./rq-util.d.mts").TFireWithoutAuth}
  */
-export function fireWithoutAuth(fn, method, endpoint, opt) {
+// @ts-expect-error 
+const fireWithoutAuth = (fn, method, endpoint, opt) => {
     if (typeof fn === "function") {
         // @ts-expect-error TODO: ts(2345) The argument type does not match the type of the specified parameter
         return fn(method, endpoint, opt);
     }
     // @ts-expect-error TODO: ts(2345) The argument type does not match the type of the specified parameter
     return fn[method](endpoint, opt);
-}
+};
+/**
+ * Need typescript v5.5 later
+ * @import * as ESI from "../v2";
+ * @typedef {ESI.TESIResponseOKMap} TESIResponseOKMap
+ * @typedef {ESI.TPathParamsNever} TPathParamsNever
+ * @typedef {ESI.IESIRequestFunction2<ESIRequestOptions>} IESIRequestFunction2
+ * @typedef {ESI.TESIRequestFunctionMethods2<ESIRequestOptions>} TESIRequestFunctionMethods2
+ */
 /**
  * #### Fire a request that does not require authentication.
  *
@@ -369,10 +368,10 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
             await fireWithoutAuth(fn, "get", `/corporations/${affiliation[0].corporation_id}/`).then(log);
             rlog("get:/incursions/".green);
             await fireWithoutAuth(fn, "get", "/incursions/").then(log);
-            fireWithoutAuth(fn, "delete", `/characters/${1234}/fittings/${56789}/`, {
-                // pathParams: [1234, 56789],
-                auth: true
-            }).catch(console.log);
+            // fireWithoutAuth(fn, "delete", `/characters/${1234}/fittings/${56789}/`, {
+            //     // pathParams: [1234, 56789],
+            //     auth: true
+            // }).catch(console.log);
         }
         // - - - - - - - - - - - -
         //     Miscellaneous
@@ -407,6 +406,7 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
             auth: true,
             token: "token.token.token"
         });
+        log(`get:/characters/${ID_CCP_Zoetrope}/ship/, returns=${willFailed}`);
         // in this case, "categories" and "search" is required
         await fireWithoutAuth(fn, "get", "/characters/{character_id}/search/", {
             pathParams: ID_CCP_Zoetrope,
@@ -416,10 +416,15 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
             },
             auth: true
         });
-        // TODO: want TypeScript semantics to throw an error because there is a required query parameter, but it's not possible
-        //   Or rather, I don't know how to do it.
-        await fireWithoutAuth(fn, "get", "/characters/{character_id}/search/");
-        log(willFailed);
+        // // TODO: want TypeScript semantics to throw an error because there is a required query parameter, but it's not possible
+        // //   Or rather, I don't know how to do it.
+        // await fireWithoutAuth(fn, "get", "/characters/{character_id}/search/", {
+        //     auth: true,
+        //     pathParams: 1234,
+        //     query: {
+        //         categories: ["alliance"], search: "test!!"
+        //     }
+        // });
     }
     catch (e) {
         console.error("Failed to request -", e);

package/minimal-rq.mjs

@@ -27,9 +27,9 @@ const log = util.getUniversalLogger("[request-mini]: ");
 // Delegates implementation to `request` (TESIRequestFunctionMethods2)
 //
 const esiMethods = /** @type {TESIRequestFunctionMethods2} */ ({});
-/** @type {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
-    esiMethods[method] = /** @type {TESIRequestFunctionEachMethod2<typeof method>} */ (function (endpoint, opt) {
-        // @ts-expect-error
+/** @satisfies {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
+    esiMethods[method] = /** @type {TESIRequestFunctionEachMethod2<typeof method, util.ESIRequestOptions>} */ ((endpoint, opt) => {
+        // @ts-expect-error ts(2345)
         return request2(method, endpoint, opt);
     });
 });
@@ -39,18 +39,20 @@ const esiMethods = /** @type {TESIRequestFunctionMethods2} */ ({});
  */
 async function getEVEStatus2(fn) {
     await util.getSDEVersion().then(sdeVersion => log(`sdeVersion: ${sdeVersion}`.blue));
+    const { clog, rlog } = util.getLogger();
+    rlog("- - - - - - - > run as IESIRequestFunction2<ESIRequestOptions>".red, fn);
     await util.fireRequestsDoesNotRequireAuth(fn);
     CaseIESIRequestFunctionMethods: {
+        rlog("- - - - - - - > run as TESIRequestFunctionMethods2<ESIRequestOptions>".red, esiMethods);
         await util.fireRequestsDoesNotRequireAuth(esiMethods);
     }
-    const { clog, rlog } = util.getLogger();
     CaseIESIRequestFunction2: {
         const ID_CCP_Zoetrope = 2112625428;
         // - - - - - - - - - - - -
         //       Character
         // - - - - - - - - - - - -
         // Here, I borrow data from "CCP Zoetrope".
-        rlog("- - - - - - - > run as IESIRequestFunction2<ESIRequestOptions>".red);
+        rlog("- - - - - - - > run as IESIRequestFunction2::TESIRequestFunctionMethods2<ESIRequestOptions>".red, fn);
         clog();
         await fn.get("/characters/{character_id}/", { pathParams: ID_CCP_Zoetrope }).then(log);
         clog('(portrait)');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "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

@@ -27,7 +27,7 @@ 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
+// node tagged-rq.mjs -x -debug -withError
 if (util.is("withError")) {
     esi.assets.get("/characters/2112625428/assets/", {
         auth: true
@@ -47,5 +47,7 @@ if (util.is("withError")) {
         pathParams: [1234, 56789],
         auth: true
     });
-    esi.character.post("/characters/affiliation/").catch(console.log);
+    esi.character.post("/characters/affiliation/", {
+        body: [12345]
+    }).catch(console.log);
 }

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

@@ -9,7 +9,7 @@
  * 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 3.0.2 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.0.4 of the EVE Online ESI response types.
  */
 import { TESIResponseOKMap, TPathParamsNever } from "./index.d.ts";
 export * from "./index.d.ts";
@@ -82,9 +82,12 @@ export declare type InferMethod<Tag> = InferSomethingBy<Tag>
  * 
  * @param endpoint - The endpoint path.
  * @param pathParams - The path parameters.
- * @param options - The request options.
+ * @param options - An optional object containing additional options for the request. If the endpoint has required parameters, this parameter must be provided.
  * @returns A promise that resolves to the response.
- * @date 2025/2/28
+ * 
+ * @remarks
+ * The `...options: HasOpt extends 1 ? [Opt] : [Opt?]` parameter is defined this way to enforce that if the endpoint has required parameters,  
+ * the `options` parameter must be provided. If there are no required parameters, the `options` parameter is optional.
  */
 export declare type TaggedEndpointRequestFunction2<M extends TESIEntryMethod, Tag extends ESITags, ActualOpt = {}> = <
   RealEP extends ReplacePathParams<keyof TESIResponseOKMap[M] & string> | keyof TESIResponseOKMap[M],
@@ -92,9 +95,10 @@ export declare type TaggedEndpointRequestFunction2<M extends TESIEntryMethod, Ta
   PathParams extends RealEP extends EP ? IfNeedPathParams<EP>: TPathParamsNever,
   Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt & PathParams>,
   R extends InferESIResponseResult<M, EP>,
+  HasOpt = HasRequireParams<TESIResponseOKMap[M][EP]> extends never ? 0 : 1
   // RealEPX = ReplacePathParamsX<RealEPX>,
   // EPX = ReplacePathParams<EP>,
->(endpoint: RealEP, options?: Opt) => Promise<R>;
+>(endpoint: RealEP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<R>;
 
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - -

package/v2/index.d.ts

@@ -9,7 +9,7 @@
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/index.d.ts
- * @summary This file is auto-generated and defines version 3.0.2 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.0.4 of the EVE Online ESI response types.
  */
 
 import type { TESIResponseOKMap } from "./response-map.d.ts";
@@ -125,9 +125,13 @@ declare global {
    * 
    * @param method - The HTTP method to use for the request (e.g., "get", "post").
    * @param endpoint - The real path of the ESI endpoint to send the request to.
-   * @param options - An optional object containing additional options for the request.
+   * @param options - An optional object containing additional options for the request. If the endpoint has required parameters, this parameter must be provided.
    * 
    * @returns A Promise object containing the response data, with the type inferred based on the method and endpoint.
+   * 
+   * @remarks
+   * The `...options: HasOpt extends 1 ? [Opt] : [Opt?]` parameter is defined this way to enforce that if the endpoint has required parameters,  
+   * the `options` parameter must be provided. If there are no required parameters, the `options` parameter is optional.
    */
   type TESIRequestFunctionSignature2<ActualOpt> = <
     M extends TESIEntryMethod,
@@ -138,8 +142,9 @@ declare global {
     // If RealEP points to an endpoint origin (not a replaced endpoint), the path parameter is required
     PathParams extends RealEP extends EP ? IfNeedPathParams<EP>: TPathParamsNever,
     Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt & PathParams>,
-    R extends InferESIResponseResult<M, EP>
-  >(method: M, endpoint: RealEP, options?: Opt) => Promise<R>;
+    R extends InferESIResponseResult<M, EP>,
+    HasOpt = HasRequireParams<TESIResponseOKMap[M][EP]> extends never ? 0 : 1
+  >(method: M, endpoint: RealEP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<R>;
 
   /**
    * Represents a function that can make ESI requests for a specific HTTP method.
@@ -156,17 +161,22 @@ declare global {
    * @template R - The response type.
    *
    * @param endpoint - The real path of the ESI endpoint to send the request to.
-   * @param options - An optional object containing additional options for the request.
+   * @param options - An optional object containing additional options for the request. If the endpoint has required parameters, this parameter must be provided.
    *
    * @returns A Promise object containing the response data, with the type inferred based on the method and endpoint.
+   * 
+   * @remarks
+   * The `...options: HasOpt extends 1 ? [Opt] : [Opt?]` parameter is defined this way to enforce that if the endpoint has required parameters,  
+   * the `options` parameter must be provided. If there are no required parameters, the `options` parameter is optional.
    */
   type TESIRequestFunctionEachMethod2<M extends TESIEntryMethod, ActualOpt = {}> = <
     RealEP extends ReplacePathParams<keyof TESIResponseOKMap[M] & string> | keyof TESIResponseOKMap[M],
     EP extends InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]> extends never ? RealEP: InferEndpointOrigin<RealEP, keyof TESIResponseOKMap[M]>,
     PathParams extends RealEP extends EP ? IfNeedPathParams<EP>: TPathParamsNever,
     Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt & PathParams>,
-    R extends InferESIResponseResult<M, EP>
-  >(endpoint: RealEP, options?: Opt) => Promise<R>;
+    R extends InferESIResponseResult<M, EP>,
+    HasOpt = HasRequireParams<TESIResponseOKMap[M][EP]> extends never ? 0 : 1
+  >(endpoint: RealEP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<R>;
 
   /**
    * Replaces path parameters in a string with numbers.
@@ -222,6 +232,22 @@ declare global {
   //   }[keyof TESIResponseOKMap[Method]]
   // }[TESIEntryMethod];
 
+  /**
+   * Determines if the given entry has required parameters.
+   * 
+   * This type checks if an entry has any required parameters by excluding the keys "result", "tag", and "cachedSeconds".
+   * If any keys remain after this exclusion, it means the entry has required parameters.
+   * 
+   * @template Entry - The entry type to check for required parameters.
+   * 
+   * @example
+   * ```ts
+   * type ExampleEntry = { result: string, tag: string, cachedSeconds: number, auth: string };
+   * type HasRequired = HasRequireParams<ExampleEntry>; // "auth"
+   * ```
+   */
+  type HasRequireParams<Entry> = Exclude<keyof Entry, "result" | "tag" | "cachedSeconds">;
+
   //  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   //                                Version 2 types
   //  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

package/v2/response-map.d.ts

@@ -9,7 +9,7 @@
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/response-map.d.ts
- * @summary This file is auto-generated and defines version 3.0.2 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.0.4 of the EVE Online ESI response types.
  */
 import "./types-index.d.ts";
 

package/v2/types-index.d.ts

@@ -9,7 +9,7 @@
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/types-index.d.ts
- * @summary This file is auto-generated and defines version 3.0.2 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.0.4 of the EVE Online ESI response types.
  */
 import "./get_wars_ok.d.ts";
 import "./get_status_ok.d.ts";

package/v2.d.mts

@@ -13,7 +13,6 @@ export declare const getRequestPending: () => number;
 /**
  * fire ESI request ESIRequestOptions
  *
- * @type {TESIRequestFunctionSignature2<ESIRequestOptions>}
  * @throws {ESIRequestError}
  * @async
  */

package/v2.mjs

@@ -35,7 +35,7 @@ let LOG = isDebug();
  * Get the number of currently executing ESI requests
  */
 let ax = 0;
-/** @type {(m?: Truthy) => number} */
+/** @type {function(Truthy=): number} */
 const incrementAx = (minus) => minus ? ax-- : ax++;
 /**
  * @returns Get The Current ESI request pending count.
@@ -47,11 +47,10 @@ export const getRequestPending = () => ax;
 /**
  * fire ESI request ESIRequestOptions
  *
- * @type {TESIRequestFunctionSignature2<ESIRequestOptions>}
  * @throws {ESIRequestError}
  * @async
  */
-export const fire = async (mthd, endp, opt) => {
+export const fire = /** @type {TESIRequestFunctionSignature2<ESIRequestOptions>} */ (async (mthd, endp, opt) => {
     /** @type {number[]=} */
     let pathParams;
     if (opt && typeof opt.pathParams !== "undefined") {
@@ -81,7 +80,7 @@ export const fire = async (mthd, endp, opt) => {
     catch (e) {
         throw e;
     }
-};
+});
 // It should complete correctly.
 /**
  * @param {TESIRequestFunctionSignature2<ESIRequestOptions>} fn