eve-esi-types 3.0.3 → 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.mjs

@@ -325,7 +325,8 @@ export function getLogger() {
  *
  * @type {import("./rq-util.d.mts").TFireWithoutAuth}
  */
-const 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);
@@ -367,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
@@ -405,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,
@@ -414,16 +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/", {
-            auth: true,
-            pathParams: 1234,
-            query: {
-                categories: ["alliance"], search: "test!!"
-            }
-        });
-        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.3",
+  "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/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.3 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],

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.3 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,
@@ -157,9 +161,13 @@ 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],

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.3 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.3 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";