eve-esi-types 3.1.3 → 3.1.4

package/lib/rq-util.d.mts

@@ -181,22 +181,11 @@ export declare function getLogger(): {
     clog: (...args: any[]) => void;
     rlog: (...args: any[]) => void;
 };
-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
- * @import * as ESI from "../v2";
- * @typedef {ESI.TESIResponseOKMap} TESIResponseOKMap
- * @typedef {ESI.TPathParamsNever} TPathParamsNever
- * @typedef {ESI.IESIRequestFunction2<ESIRequestOptions>} IESIRequestFunction2
- * @typedef {ESI.TESIRequestFunctionMethods2<ESIRequestOptions>} TESIRequestFunctionMethods2
- */
+type TPrependParams = TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>;
 /**
  * #### Fire a request that does not require authentication.
  *
- * @param {TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2} fn
+ * @param {TPrependParams} fn
  * @returns {Promise<void>}
  */
-export declare function fireRequestsDoesNotRequireAuth(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>): Promise<void>;
+export declare function fireRequestsDoesNotRequireAuth(fn: TPrependParams): Promise<void>;

package/lib/rq-util.mjs

@@ -320,55 +320,37 @@ export function getLogger() {
     const rlog = consoleUtil.getLogger("- - -> Run ESI request".cyan);
     return { clog, rlog };
 }
-/* ctt
-// Result: `/characters/${number}/fittings/${number}/`
-type Example = ReplacePathParams<"/characters/{character_id}/fittings/{fitting_id}/">;
-
-// Result: "/characters/{character_id}/fittings/{fitting_id}/"
-type ResovedEP = ResolvedEndpoint<"/characters/123/fittings/456/", "delete">;
-// Result: "/characters/{character_id}/fittings/{fitting_id}/"
-type ResovedEP2 = ResolvedEndpoint<"/characters/{character_id}/fittings/{fitting_id}/", "delete">;
-type IncompleteEP = ResolvedEndpoint<"/characters/1234/fittings/{fitting_id}/", "delete">;
-
-// Result: "/characters/{character_id}/fittings/{fitting_id}/"
-type EPOriginOK = InferEndpointOrigin<"/characters/123/fittings/456/", "delete">;
-// result: never
-type EPOriginNever = InferEndpointOrigin<"/characters/123/fittings/{fitting_id}/", "delete">;
-// result: never
-type EPOriginNever2 = InferEndpointOrigin<"/characters/{character_id}/fittings/456/", "delete">;
-/*/
-//*/
+/**
+ * Need typescript v5.5 later
+ * @import * as ESI from "../v2";
+ * @typedef {ESI.TESIRequestFunctionMethods2<ESIRequestOptions>} TESIRequestFunctionMethods2
+ */
+/**
+ * @typedef {TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2} TPrependParams
+ */
 /**
  * #### Fire a request that does not require authentication.
  *
- * @type {import("./rq-util.d.mts").TFireWithoutAuth}
+ * @type {TESIEnhancedRequestFunctionSignature<TPrependParams, ESIRequestOptions>}
  */
-// @ts-expect -error 
 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
+        const arg = opt.length ? opt[0] : void 0;
         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);
+    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
- */
+const token = `token.token.token`;
 /**
  * #### Fire a request that does not require authentication.
  *
- * @param {TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2} fn
+ * @param {TPrependParams} fn
  * @returns {Promise<void>}
  */
 export async function fireRequestsDoesNotRequireAuth(fn) {
     const { clog, rlog } = getLogger();
+    const ID_SomeEVECharacter = 90000;
     const ID_CCP_Zoetrope = 2112625428;
     try {
         // - - - - - - - - - - - -
@@ -393,12 +375,15 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
             if (is("withError")) {
                 await fireWithoutAuth(fn, "get", "/characters/{character_id}/assets/", {
                     auth: true,
-                    pathParams: 12354
+                    pathParams: ID_SomeEVECharacter,
+                    token
+                }).then(assets => {
+                    log(assets.slice(0, 5));
                 });
                 await fireWithoutAuth(fn, "delete", `/characters/${1234}/fittings/${56789}/`, {
                     auth: true,
                     // pathParams: [1234, 56789], // ✅ At this point, the expected semantic error is successfully triggered as intended.
-                }).catch(console.log);
+                }).catch(log);
             }
         }
         // - - - - - - - - - - - -
@@ -430,20 +415,21 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
         //  The following is code to observe the behavior of completion by generics.
         //  Authentication is required, so an error will occur.
         // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
-        let willFailed = await fireWithoutAuth(fn, "get", `/characters/${ID_CCP_Zoetrope}/ship/`, {
+        let willFailed = await fireWithoutAuth(fn, "get", `/characters/${ID_SomeEVECharacter}/ship/`, {
             auth: true,
-            token: "token.token.token"
+            token //: "token.token.token"
         });
-        log(`get:/characters/${ID_CCP_Zoetrope}/ship/, returns=${willFailed}`);
+        log(`get:/characters/${ID_SomeEVECharacter}/ship/, returns:`, willFailed);
         // in this case, "categories" and "search" is required
         await fireWithoutAuth(fn, "get", "/characters/{character_id}/search/", {
-            pathParams: ID_CCP_Zoetrope,
+            pathParams: ID_SomeEVECharacter,
             query: {
-                categories: ["agent"],
-                search: "ok"
+                categories: ["inventory_type"],
+                search: "plex"
             },
-            auth: true
-        });
+            auth: true,
+            token
+        }).then(log);
         // // 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/", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "3.1.3",
+  "version": "3.1.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.1.3 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.4 of the EVE Online ESI response types.
  */
 import { TESIResponseOKMap } from "./index.d.ts";
 export * from "./index.d.ts";

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.3 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.4 of the EVE Online ESI response types.
  */
 import type { TESIResponseOKMap } from "./response-map.d.ts";
 export type { TESIResponseOKMap } from "./response-map.d.ts";
@@ -36,7 +36,7 @@ import type { PickPathParameters, InferKeysLen } from "./util.d.ts";
  * });
  * ```
  */
-export interface IESIRequestFunction2<ActualOpt>
+export interface IESIRequestFunction2<ActualOpt extends Record<string, unknown>>
   extends TESIRequestFunctionSignature2<ActualOpt>, TESIRequestFunctionMethods2<ActualOpt> {
 }
 
@@ -63,7 +63,7 @@ export interface IESIRequestFunction2<ActualOpt>
  * });
  * ```
  */
-export type TESIRequestFunctionMethods2<ActualOpt = {}> = {
+export type TESIRequestFunctionMethods2<ActualOpt extends Record<string, unknown>> = {
   [method in TESIEntryMethod]: TESIRequestFunctionEachMethod2<method, ActualOpt>;
 }
 
@@ -177,7 +177,7 @@ type ESIEntryKeys = "auth" | "query" | "body" | "pathParams";
  *
  * @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 RequireKeys - The keys to retain in the resulting type.
  * @template Extras - Automatically derived keys to exclude from the resulting type.
  *
  * @example
@@ -190,11 +190,10 @@ type ESIEntryKeys = "auth" | "query" | "body" | "pathParams";
  */
 //* ctt
 type RestrictKeys<
-T, K extends keyof T,
-Extras = Exclude<ESIEntryKeys, K>
+  T, RequireKeys extends keyof T,
+  Extras = Exclude<ESIEntryKeys, RequireKeys>
 > = {
-  [P in keyof T]: P extends K ? Pick<T, P>[P] :
-    P extends Extras ? never : T[P];
+  [P in keyof T]: P extends Extras ? never : T[P];
 };
 // type RequireEntry = {
 //   auth?: true;
@@ -230,7 +229,9 @@ declare global {
    * ```
    */
   type RequireThese<T, K extends keyof T> = {
-    [P in keyof T]: P extends K ? Required<Pick<T, P>>[P] : T[P];
+    [P in keyof T as P extends K ? P : never]-?: T[P];
+  } & {
+    [P in keyof T as P extends K ? never : P]: T[P];
   };
 
   //  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -262,7 +263,7 @@ declare global {
    * 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> = <
+  type TESIRequestFunctionSignature2<ActualOpt extends Record<string, unknown>> = <
     Mtd extends TESIEntryMethod,
     REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>,
     EPX extends ResolvedEndpoint<REP, Mtd>,
@@ -272,6 +273,52 @@ declare global {
     HasOpt = HasRequireParams<Mtd, EPX, PPM>,
   >(method: Mtd, endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
 
+  /**
+   * A function signature type for making enhanced ESI requests.
+   *
+   * This type extends the base ESI request function signature by injecting a prepended parameter to allow for extra
+   * context or pre-processing before performing the request. It provides a highly generic interface that adapts to the
+   * chosen endpoint method, endpoint configuration, and additional options, making it ideal for advanced API interactions.
+   *
+   * Generic Parameters:
+   * @template PrependParam - The type of the additional parameter that is injected at the beginning of the function call.
+   * @template ActualOpt - An object representing the default options (typically extending ESIRequestOptions) used for the request.
+   *
+   * Function Generic Parameters:
+   * @template Mtd - The ESI request method type (e.g., GET, POST) as defined in TESIEntryMethod.
+   * @template REP - The endpoint type, which can be either a version with replaced path parameters (via ReplacePathParams)
+   *                 or the raw ESIEndpointOf<Mtd> type.
+   * @template EPX - The resolved endpoint type derived from REP and Mtd.
+   * @template PPM - The type representing the inferred path parameters extracted from REP and EPX.
+   * @template Opt - The type for additional request options, identified based on the method (Mtd), endpoint (EPX), the
+   *                 default options (ActualOpt), and inferred path parameters (PPM).
+   * @template Ret - The type of the response result from the ESI request, inferred from the method and endpoint.
+   * @template HasOpt - An internal flag used to determine whether request options (Opt) are required (1) or optional.
+   *
+   * Parameters:
+   * @param {PrependParam} prependParam - A prepended parameter providing additional context or configuration for the request.
+   * @param {Mtd} method - The ESI request method.
+   * @param {REP} endpoint - The API endpoint, which might include path parameter replacements.
+   * @param {...(HasOpt extends 1 ? [Opt] : [Opt?])} options - Additional options for the request; required if HasOpt is 1,
+   *   otherwise optional.
+   *
+   * @returns {Promise<Ret>} A promise that resolves with the result type `Ret`, representing the response data from the ESI endpoint.
+   */
+  type TESIEnhancedRequestFunctionSignature<
+    PrependParam extends unknown, ActualOpt extends Record<string, unknown>
+  > = <
+    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>
+  >(
+    prependParam: PrependParam,
+    method: Mtd, endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]
+  ) => Promise<Ret>;
+
   /**
    * Represents a function that can make ESI requests for a specific HTTP method.
    *
@@ -295,7 +342,7 @@ declare global {
    * 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<Mtd extends TESIEntryMethod, ActualOpt = {}> = <
+  type TESIRequestFunctionEachMethod2<Mtd extends TESIEntryMethod, ActualOpt extends Record<string, unknown>> = <
     REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>,
     EPX extends ResolvedEndpoint<REP, Mtd>,
     PPM extends InferPathParams<REP, EPX>,
@@ -458,7 +505,7 @@ declare global {
    * @template EPx - The endpoint path.
    * @template Opt - The type of the additional options.
    * @template Entry - The entry type to identify parameters for.
-   * @template Keys - The keys of the entry type that are required parameters.
+   * @template RequireKeys - The keys of the entry type that are required parameters.
    * 
    * @example
    * ```ts
@@ -477,10 +524,10 @@ declare global {
     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, Keys> & Pick<Entry, Keys> & AdditionalParams;
+    Entry = _ESIResponseType<M, EPx> & AdditionalParams,
+    RequireKeys = Exclude<keyof (Entry & AdditionalParams), "result" | "tag" | "cachedSeconds">
+    // @ts-expect-error 
+  > = RestrictKeys<Opt, RequireKeys> & Pick<Entry, RequireKeys> & 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.

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