eve-esi-types 3.1.2 → 3.1.3

package/lib/request-api.mjs

@@ -70,7 +70,7 @@ export const request2 = /** @type {IESIRequestFunction2} */ (async (method, endp
 //
 /** @type {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
     request2[method] = /** @type {TESIRequestFunctionEachMethod2<typeof method, util.ESIRequestOptions>} */ ((endpoint, opt) => {
-        // @ts-expect-error TODO: ts(2345)
-        return request2(method, endpoint, opt);
+        // @ts-expect- error TODO: ts(2345)
+        return request2(method, endpoint, /** @type {Parameters<typeof request2>[2]} */ (opt));
     });
 });

package/lib/rq-util.d.mts

@@ -37,14 +37,6 @@ export type ESIRequestOptions = {
      * will need it for `POST` request etc.
      */
     body?: any;
-    /**
-     * cancel request immediately
-     */
-    cancelable?: AbortController;
-    /**
-     * Can be an empty object if no authentication is required.description
-     */
-    token?: TAcccessToken;
     /**
      * whether an authorization header is required
      *
@@ -57,7 +49,15 @@ export type ESIRequestOptions = {
      * @date 2025/3/13
      * @since v3.0.0
      */
-    pathParams?: number | number[];
+    pathParams?: number | [number, number];
+    /**
+     * Can be an empty object if no authentication is required.description
+     */
+    token?: TAcccessToken;
+    /**
+     * cancel request immediately
+     */
+    cancelable?: AbortController;
 };
 /**
  * @typedef {string | number | boolean} Truthy
@@ -141,7 +141,7 @@ export declare const initOptions: (method: string, opt: ESIRequestOptions) => {
  * fetch the extra pages
  *
  *   + if the `x-pages` header property ware more than 1
- * @template {any} T
+ * @template {unknown} T
  * @param {string} endpointUrl
  * @param {RequestInit} rqopt request options
  * @param {URLSearchParams} usp queries
@@ -181,9 +181,9 @@ export declare function getLogger(): {
     clog: (...args: any[]) => void;
     rlog: (...args: any[]) => void;
 };
-export type TFireWithoutAuth<ActualOpt = ESIRequestOptions> = <Mtd extends TESIEntryMethod, REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>, EPX extends ResolvedEndpoint<REP, Mtd>, PPM extends InferPathParams<REP, EPX>, Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>, Ret extends InferESIResponseResult<Mtd, EPX>, HasOpt = HasRequireParams<Mtd, EPX, PPM>, XX = PickRequireParams<Mtd, EPX, PPM>>(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>, method: Mtd, endpoint: REP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
-export interface IFireWithoutAuth<ActualOpt = ESIRequestOptions> {
-    <Mtd extends TESIEntryMethod, REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>, EPX extends ResolvedEndpoint<REP, Mtd>, PPM extends InferPathParams<REP, EPX>, Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>, Ret extends InferESIResponseResult<Mtd, EPX>, HasOpt = HasRequireParams<Mtd, EPX, PPM>, XX = PickRequireParams<Mtd, EPX, PPM>>(fn: TESIRequestFunctionSignature2<ActualOpt> | TESIRequestFunctionMethods2<ActualOpt>, method: Mtd, endpoint: REP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]): Promise<Ret>;
+export type TFireWithoutAuth<ActualOpt extends Record<string, unknown> = ESIRequestOptions> = <Mtd extends TESIEntryMethod, REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>, EPX extends ResolvedEndpoint<REP, Mtd>, PPM extends InferPathParams<REP, EPX>, Opt extends IdentifyParameters<Mtd, EPX, ActualOpt, PPM>, Ret extends InferESIResponseResult<Mtd, EPX>, HasOpt = HasRequireParams<Mtd, EPX, PPM>, XX = PickRequireParams<Mtd, EPX, PPM>>(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>, method: Mtd, endpoint: REP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
+export interface IFireWithoutAuth<ActualOpt extends Record<string, unknown> = ESIRequestOptions> {
+    <Mtd extends TESIEntryMethod, REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>, EPX extends ResolvedEndpoint<REP, Mtd>, PPM extends InferPathParams<REP, EPX>, Opt extends IdentifyParameters<Mtd, EPX, ActualOpt, PPM>, Ret extends InferESIResponseResult<Mtd, EPX>, HasOpt = HasRequireParams<Mtd, EPX, PPM>, XX = PickRequireParams<Mtd, EPX, PPM>>(fn: TESIRequestFunctionSignature2<ActualOpt> | TESIRequestFunctionMethods2<ActualOpt>, method: Mtd, endpoint: REP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]): Promise<Ret>;
 }
 /**
  * Need typescript v5.5 later

package/lib/rq-util.mjs

@@ -228,7 +228,7 @@ export const initOptions = (method, opt) => {
  * fetch the extra pages
  *
  *   + if the `x-pages` header property ware more than 1
- * @template {any} T
+ * @template {unknown} T
  * @param {string} endpointUrl
  * @param {RequestInit} rqopt request options
  * @param {URLSearchParams} usp queries
@@ -347,8 +347,8 @@ type EPOriginNever2 = InferEndpointOrigin<"/characters/{character_id}/fittings/4
 const fireWithoutAuth = (fn, method, endpoint, ...opt) => {
     const arg = opt.length ? opt[0] : void 0;
     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, arg);
+        // @ts-expect- error TODO: ts(2345) The argument type does not match the type of the specified parameter
+        return fn(method, endpoint, /** @type {Parameters<typeof fn>[2]} */ (arg));
     }
     // @ts-expect-error TODO: ts(2345) The argument type does not match the type of the specified parameter
     return fn[method](endpoint, arg);
@@ -378,6 +378,7 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
         clog();
         casefireWithoutAuth: {
             await fireWithoutAuth(fn, "get", `/characters/{character_id}/`, {
+                // auth: true, // ✅ At this point, the expected semantic error is successfully triggered as intended.
                 pathParams: ID_CCP_Zoetrope
             }).then(log);
             clog('(portrait)');
@@ -395,8 +396,8 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
                     pathParams: 12354
                 });
                 await fireWithoutAuth(fn, "delete", `/characters/${1234}/fittings/${56789}/`, {
-                    pathParams: [1234, 56789], // ⚠️ TODO: A semantics error should be deliberately caused here
-                    auth: true
+                    auth: true,
+                    // pathParams: [1234, 56789], // ✅ At this point, the expected semantic error is successfully triggered as intended.
                 }).catch(console.log);
             }
         }

package/minimal-rq.mjs

@@ -29,8 +29,8 @@ const log = util.getUniversalLogger("[request-mini]: ");
 const esiMethods = /** @type {TESIRequestFunctionMethods2} */ ({});
 /** @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);
+        // @ts-expect -error ts(2345)
+        return request2(method, endpoint, /** @type {Parameters<typeof request2>[2]} */ (opt));
     });
 });
 // It should complete correctly.

package/package.json

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

@@ -44,7 +44,7 @@ if (util.is("withError")) {
         // token: "s.s.s"
     })).then(console.log).catch(console.log);
     esi.fittings.delete("/characters/1234/fittings/56789/", {
-        pathParams: [1234, 56789], // ⚠️ TODO: A semantics error should be deliberately caused here
+        // pathParams: [1234, 56789], // ✅ At this point, the expected semantic error is successfully triggered as intended.
         auth: true
     });
     esi.character.post("/characters/affiliation/", {

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.1.1 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.3 of the EVE Online ESI response types.
  */
 import { TESIResponseOKMap } from "./index.d.ts";
 export * from "./index.d.ts";
@@ -121,7 +121,7 @@ export declare type TaggedEndpointRequestFunction2<
     REP extends ReplacePathParams<EndPoints> | EndPoints,
     EPX extends _InferEndpointOrigin<REP, EndPoints> extends never ? REP: _InferEndpointOrigin<REP, EndPoints>,
     PPM extends InferPathParams<REP, EPX>,
-    Opt extends IdentifyParameters<M, EPX, ActualOpt & PPM>,
+    Opt extends IdentifyParameters<M, EPX, ActualOpt, PPM>,
     Ret extends InferESIResponseResult<M, EPX>,
     HasOpt = HasRequireParams<M, EPX, PPM>,
 >(endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;

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.1.1 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.3 of the EVE Online ESI response types.
  */
 import type { TESIResponseOKMap } from "./response-map.d.ts";
 export type { TESIResponseOKMap } from "./response-map.d.ts";
@@ -163,6 +163,56 @@ export type __IdentifyParameters<
   // @ts-expect-error 
 > = RequireThese<Opt, Keys> & Pick<Entry, Keys>;
 
+//  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+//                         Internal types
+//  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+/**
+ * Defines the keys used in ESI entries.
+ */
+type ESIEntryKeys = "auth" | "query" | "body" | "pathParams";
+/**
+ * Restricts the keys of a type to the specified ones while excluding extra keys.
+ *
+ * This utility type is designed to enforce stricter semantics by marking unwanted keys as `never`.
+ *
+ * @template T - The original type to be constrained.
+ * @template T2 - The type to merge with the constrained type.
+ * @template K - The keys to retain in the resulting type.
+ * @template Extras - Automatically derived keys to exclude from the resulting type.
+ *
+ * @example
+ * ```ts
+ * type Original = { auth?: string; query?: string; body?: string; pathParams?: string; extra?: string };
+ * type Required = { auth: true; query: { test: "pen" | "pencil" } };
+ * type Restricted = RestrictKeys<Original, Required, "auth" | "query">;
+ * // Result: { auth: true; query: { test: "pen" | "pencil" }; body?: undefined; pathParams?: undefined; extra?: string | undefined }
+ * ```
+ */
+//* ctt
+type RestrictKeys<
+T, K extends keyof T,
+Extras = Exclude<ESIEntryKeys, K>
+> = {
+  [P in keyof T]: P extends K ? Pick<T, P>[P] :
+    P extends Extras ? never : T[P];
+};
+// type RequireEntry = {
+//   auth?: true;
+//   query?: { test: "pen" | "pencil" };
+//   body?: string;
+//   pathParams?: string;
+//   extra?: string
+// };
+// type Restricted = RestrictKeys<RequireEntry, "auth" | "query">;
+/*/
+type RestrictKeys<
+  T, T2,
+  K extends keyof T,
+  Extras = Exclude<ESIEntryKeys, K>
+> = T2 & {
+  [P in keyof T as P extends K ? never : P]: P extends Extras ? never : T[P];
+};
+//*/
 
 declare global {
 
@@ -217,7 +267,7 @@ declare global {
     REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>,
     EPX extends ResolvedEndpoint<REP, Mtd>,
     PPM extends InferPathParams<REP, EPX>,
-    Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>,
+    Opt extends IdentifyParameters<Mtd, EPX, ActualOpt, PPM>,
     Ret extends InferESIResponseResult<Mtd, EPX>,
     HasOpt = HasRequireParams<Mtd, EPX, PPM>,
   >(method: Mtd, endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
@@ -249,9 +299,9 @@ declare global {
     REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>,
     EPX extends ResolvedEndpoint<REP, Mtd>,
     PPM extends InferPathParams<REP, EPX>,
-    Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>,
+    Opt extends IdentifyParameters<Mtd, EPX, ActualOpt, PPM>,
     Ret extends InferESIResponseResult<Mtd, EPX>,
-    HasOpt = HasRequireParams<Mtd, EPX, PPM>,
+    HasOpt extends HasRequireParams<Mtd, EPX, PPM> = HasRequireParams<Mtd, EPX, PPM>,
   >(endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
 
   /**
@@ -426,20 +476,23 @@ declare global {
     M extends TESIEntryMethod,
     EPx extends ESIEndpointOf<M> | string,
     Opt extends Record<string, unknown>,
+    AdditionalParams,
     Entry = _ESIResponseType<M, EPx>,
-    Keys = Exclude<keyof Entry, "result" | "tag" | "cachedSeconds">
-    // @ts-expect-error 
-  > = RequireThese<Opt, Keys> & Pick<Entry, Keys>;
+    Keys = Exclude<keyof (Entry & AdditionalParams), "result" | "tag" | "cachedSeconds">
+    // @ts-expect- error 
+  > = RestrictKeys<Opt, Keys> & Pick<Entry, Keys> & AdditionalParams;
   /*/
+  // DEVNOTE: 2025/3/24
+  // The definition is simple and highly maintainable, but it is not possible to reference the `pathParams` property when implementing `TESIRequestFunctionSignature2` etc.
   type IdentifyParameters<
-    Entry, Opt,
-    Keys = Exclude<keyof Entry, "result" | "tag" | "cachedSeconds">
-    // @ts-expect-error 
-  > = RequireThese<Opt, Keys> & Pick<Entry, Keys>;
-  // type IdentifyParameters<
-  //   Entry, Opt,
-  //   Keys = Exclude<keyof Entry, "result">
-  // > = Opt & (Keys extends keyof Entry ? Pick<Entry, Keys> : {});
+    M extends TESIEntryMethod,
+    EPx extends ESIEndpointOf<M> | string,
+    Opt extends Record<string, unknown>,
+    AdditionalParams,
+    Entry = _ESIResponseType<M, EPx>,
+    Keys = Exclude<keyof (Entry & AdditionalParams), "result" | "tag" | "cachedSeconds">
+    // @ts-expect- error 
+  > = RestrictKeys<Opt, Pick<Entry, Keys> & AdditionalParams, Keys>;
   //*/
 
   /**

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.1.1 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.3 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.1.1 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.3 of the EVE Online ESI response types.
  */
 import "./get_wars_ok.d.ts";
 import "./get_status_ok.d.ts";