eve-esi-types 2.2.1 → 2.2.4

package/v2/index.d.ts

@@ -9,7 +9,7 @@
  * THIS TSD IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/index.d.ts
- * @summary This file is auto-generated and defines version 2.2.1 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 2.2.4 of the EVE Online ESI response types.
  */
 import "./get_alliances_ok.d.ts";
 import "./get_alliances_alliance_id_ok.d.ts";
@@ -203,6 +203,57 @@ import "./extra-types.d.ts";
  */
 type RequireThese<T, K extends keyof T> = T & Required<Pick<T, K>>;
 
+/**
+ * Represents a function that can make ESI requests with various HTTP methods.
+ *
+ * @template ActualOpt - The actual type of the options.
+ *
+ * @example
+ * ```ts
+ * // @ ts-expect-error
+ * export const request: IESIRequestFunction<ESIRequestOptions> = (method, endpoint, pathParams, opt) => {
+ * // Implementation for "get" | "post" | "put" | "delete" request
+ * };
+ * // You can easily implement "get" | "post" | "put" | "delete" requests
+ * // with code like the following:
+ * (["get", "post", "put", "delete"] as (keyof typeof request)[]).forEach((method) => {
+ *     request[method] = function (this: typeof request, endpoint, params, opt) {
+ *         return this(method, endpoint, params, opt);
+ *     } as TESIRequestFunctionEachMethod<typeof method>;
+ * });
+ * ```
+ */
+export interface IESIRequestFunction<ActualOpt>
+  extends TESIRequestFunctionSignature<ActualOpt>, TESIRequestFunctionMethods<ActualOpt> {
+}
+
+/**
+ * Represents the methods available for making ESI requests.
+ * 
+ *  + This interface is used when you already have implementation code such as  
+ *    TESIRequestFunctionSignature and you want to implement additional shorthand methods.
+ *
+ * @template ActualOpt - The actual type of the options.
+ *
+ * @example
+ * ```ts
+ * export const request: TESIRequestFunctionSignature<ESIRequestOptions> = (method, endpoint, pathParams, opt) => {
+ * // Implementation for "get" | "post" | "put" | "delete" request
+ * };
+ * // You can easily implement "get" | "post" | "put" | "delete" requests
+ * // with code like the following:
+ * const esiMethods = {} as TESIRequestFunctionMethods<ESIRequestOptions>;
+ * (["get", "post", "put", "delete"] as (keyof TESIRequestFunctionMethods)[]).forEach((method) => {
+ *     esiMethods[method] = function (endpoint, params, opt) {
+ *         return request(method, endpoint, params, opt);
+ *     } as TESIRequestFunctionEachMethod<typeof method>;
+ * });
+ * ```
+ */
+export type TESIRequestFunctionMethods<ActualOpt = {}> = {
+  [method in TESIEntryMethod]: TESIRequestFunctionEachMethod<method, ActualOpt>;
+}
+
 declare global {
 
   /**
@@ -224,15 +275,40 @@ declare global {
   type TESIRequestFunctionSignature<ActualOpt> = <
     M extends TESIEntryMethod,
     EP extends keyof TESIResponseOKMap[M],
-    P2 extends IsParameterizedPath<EP, number | number[], Opt>,
+    P2 extends IfParameterizedPath<EP, Opt>,
     Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt>,
     R extends InferESIResponseResult<M, EP>
   >(method: M, endpoint: EP, pathParams?: P2, options?: Opt) => Promise<R>;
 
   /**
-   * is parameterized path
+   * Represents a function that makes an ESI request using a specific HTTP method.
+   *
+   * @template M - The HTTP method to use for the request (e.g., "get", "post").
+   * @template ActualOpt - The actual type of the options to include in the request.
+   * 
+   * @param endpoint - The path of the ESI endpoint to send the request to.
+   * @param pathParams - An optional parameter that can be a number, an array of numbers, or other parameters
+   *                     depending on whether the path is parameterized.
+   * @param options - An optional object containing additional options for the request.
+   * 
+   * @returns A Promise object containing the response data, with the type inferred based on the method and endpoint.
    */
-  type IsParameterizedPath<EP, A, B> = EP extends `${string}/{${string}}/${string | ""}` ? A: B;
+  type TESIRequestFunctionEachMethod<M extends TESIEntryMethod, ActualOpt = {}> = <
+    EP extends keyof TESIResponseOKMap[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>;
+
+  // /**
+  //  * is parameterized path
+  //  */
+  // type IsParameterizedPath<EP, A, B> = EP extends `${string}/{${string}}/${string | ""}` ? A: B;
+  /**
+   * if parameterized path then specify number type, otherwise will be `Opt` type.
+   */
+  type IfParameterizedPath<EP, Opt> = EP extends `${string}/{${string}}/${string | ""}` ? number | number[]: Opt;
+
   /**
    * Identifies the required parameters for a given entry type.
    *

package/v2.d.mts

@@ -11,7 +11,7 @@ import { type ESIRequestOptions } from "./rq-util.mjs";
  * fire ESI request
  * @template {TESIEntryMethod} M
  * @template {keyof TESIResponseOKMap[M]} EP
- * @template {IsParameterizedPath<EP, number | number[], Opt>} P2
+ * @template {IfParameterizedPath<EP, Opt>} P2
  * @template {IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>} Opt
  * @template {InferESIResponseResult<M, EP>} R
  *
@@ -23,10 +23,4 @@ import { type ESIRequestOptions } from "./rq-util.mjs";
  * @throws
  * @async
  */
-export declare function fire<
-    M extends TESIEntryMethod,
-    EP extends keyof TESIResponseOKMap[M],
-    Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>,
-    P2 extends IsParameterizedPath<EP, number | number[], Opt>,
-    R extends InferESIResponseResult<M, EP>
->(mthd: M, endp: EP, pathParams?: P2, opt?: Opt): Promise<R>;
+export declare function fire<M extends TESIEntryMethod, EP extends keyof TESIResponseOKMap[M], P2 extends IfParameterizedPath<EP, Opt>, Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>, R extends InferESIResponseResult<M, EP>>(mthd: M, endp: EP, pathParams?: P2, opt?: Opt): Promise<R>;

package/v2.mjs

@@ -29,7 +29,7 @@ const incrementAx = (minus) => minus ? ax-- : ax++;
  * fire ESI request
  * @template {TESIEntryMethod} M
  * @template {keyof TESIResponseOKMap[M]} EP
- * @template {IsParameterizedPath<EP, number | number[], Opt>} P2
+ * @template {IfParameterizedPath<EP, Opt>} P2
  * @template {IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>} Opt
  * @template {InferESIResponseResult<M, EP>} R
  *
@@ -43,11 +43,11 @@ const incrementAx = (minus) => minus ? ax-- : ax++;
  */
 export async function fire(mthd, endp, pathParams, opt) {
     if (typeof pathParams === "number") {
-        // @ts-ignore 
+        // @ts-expect-error
         pathParams = [pathParams]; // as unknown as P2;
     }
     if (isArray(pathParams)) {
-        // @ts-ignore actualy endp is string
+        // @ts-expect-error actualy endp is string
         endp = replaceCbt(endp, pathParams);
     }
     // When only options are provided
@@ -55,13 +55,13 @@ export async function fire(mthd, endp, pathParams, opt) {
     // @ts-ignore
     const actualOpt = opt || pathParams || {};
     const { rqopt, qss } = initOptions(mthd, actualOpt);
-    // @ts-ignore actualy endp is string
+    // @ts-expect-error actualy endp is string
     const endpointUrl = curl(endp);
-    const url = `${endpointUrl}?${new URLSearchParams(qss) + ""}`;
+    const up = new URLSearchParams(qss);
+    const url = `${endpointUrl}${up.size ? `?${up}` : ""}`;
     LOG && log(url);
     ax++;
     try {
-        // @ts-ignore A silly type error will appear, but ignore it.
         const res = await fetch(url, rqopt).finally(() => ax--);
         const { status } = res;
         if (!res.ok && !actualOpt.ignoreError) {
@@ -88,19 +88,19 @@ export async function fire(mthd, endp, pathParams, opt) {
             }
             // - - - - x-pages response.
             // +undefined is NaN
-            // @ts-ignore becouse +null is 0
+            // @ts-expect-error becouse +null is 0
             const pc = +res.headers.get("x-pages");
             // has remaining pages? NaN > 1 === false !isNaN(pageCount)
             if (pc > 1) {
                 LOG && log('found "x-pages" header, pages: %d', pc);
-                const remData = await fetchP(endpointUrl, rqopt, qss, pc, incrementAx);
+                const remData = await fetchP(endpointUrl, rqopt, up, pc, incrementAx);
                 // finally, decide product data.
                 if (isArray(data) && isArray(remData)) {
                     // DEVNOTE: 2019/7/23 15:01:48 - types
                     return /** @type {R} */ (data.concat(remData));
                 }
                 else {
-                    // @ts-ignore TODO: fix type
+                    // @ts-expect-error TODO: fix type
                     remData && Object.assign(data, remData);
                 }
             }
@@ -108,7 +108,7 @@ export async function fire(mthd, endp, pathParams, opt) {
         }
     }
     catch (e) {
-        // @ts-ignore actualy endp is string
+        // @ts-expect-error actualy endp is string
         throw new ESIRequesError(`message: ${e.message}, endpoint=${endp}`);
     }
 }
@@ -123,7 +123,6 @@ async function getEVEStatus(fn) {
     return fn("get", "/status/");
 }
 // type following and run
-// bun scripts/v2.mts
 // node v2.mjs
 // or yarn test
 getEVEStatus(fire).then(eveStatus => console.log(eveStatus));