eve-esi-types 2.3.5 → 3.0.1

package/v2.mjs

@@ -1,3 +1,15 @@
+/*!
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
+  Released under the MIT license
+  https://opensource.org/licenses/mit-license.php
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/// <reference types="./v2"/>
+// - - - - - - - - - - - - - - - - - - - -
+//               imports
+// - - - - - - - - - - - - - - - - - - - -
+// import type { TESIResponseOKMap, TPathParamsNever } from "./v2";
 // import type { TESIResponseOKMap } from "eve-esi-types";
 import { is, curl, replaceCbt, getSDEVersion, initOptions, isDebug, fireRequestsDoesNotRequireAuth, isSuccess, handleESIError, handleSuccessResponse } from "./lib/rq-util.mjs";
 // - - - - - - - - - - - - - - - - - - - -
@@ -13,6 +25,8 @@ let LOG = isDebug();
 /**
  * @typedef {import("./v2").TESIResponseOKMap} TESIResponseOKMap
  * @typedef {import("./lib/rq-util.mjs").ESIRequestOptions} ESIRequestOptions
+ * @typedef {import("./lib/rq-util.mjs").ESIRequestError} ESIRequestError
+ * @typedef {import("./lib/rq-util.mjs").Truthy} Truthy
  */
 // - - - - - - - - - - - - - - - - - - - -
 //        module vars, functions
@@ -21,6 +35,7 @@ let LOG = isDebug();
  * Get the number of currently executing ESI requests
  */
 let ax = 0;
+/** @type {(m?: Truthy) => number} */
 const incrementAx = (minus) => minus ? ax-- : ax++;
 /**
  * @returns Get The Current ESI request pending count.
@@ -30,33 +45,23 @@ export const getRequestPending = () => ax;
 //            main functions
 // - - - - - - - - - - - - - - - - - - - -
 /**
- * fire ESI request
- * @template {TESIEntryMethod} M
- * @template {keyof TESIResponseOKMap[M]} EP
- * @template {IfParameterizedPath<EP, Opt>} P2
- * @template {IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>} Opt
- * @template {InferESIResponseResult<M, EP>} R
+ * fire ESI request ESIRequestOptions
  *
- * @param {M} mthd
- * @param {EP} endp - The endpoint to request.
- * @param {Opt} [opt] - default is empty object {}. `body` is json string
- * @param {P2} [pathParams] - Optional path parameters.
- * @returns {Promise<R>} - The response from the endpoint.
- * @throws
+ * @type {TESIRequestFunctionSignature2<ESIRequestOptions>}
+ * @throws {ESIRequestError}
  * @async
  */
-export async function fire(mthd, endp, pathParams, opt) {
-    if (typeof pathParams === "number") {
-        // @ts-expect-error
-        pathParams = [pathParams]; // as unknown as P2;
+export const fire = async (mthd, endp, opt) => {
+    /** @type {number[]=} */
+    let pathParams;
+    if (opt && typeof opt.pathParams !== "undefined") {
+        pathParams = typeof opt.pathParams === "number" ? [opt.pathParams] : isArray(opt.pathParams) ? opt.pathParams : void 0;
     }
     if (isArray(pathParams)) {
         endp = replaceCbt(endp, pathParams);
     }
     // When only options are provided
-    /** @type {Opt} */
-    // @ts-ignore
-    const actualOpt = opt || pathParams || {};
+    const actualOpt = opt || /** @type {NonNullable<typeof opt>} */ ({});
     const { rqopt, qss } = initOptions(mthd, actualOpt);
     const endpointUrl = curl(endp);
     const up = new URLSearchParams(qss);
@@ -76,10 +81,10 @@ export async function fire(mthd, endp, pathParams, opt) {
     catch (e) {
         throw e;
     }
-}
+};
 // It should complete correctly.
 /**
- * @param {TESIRequestFunctionSignature<ESIRequestOptions>} fn
+ * @param {TESIRequestFunctionSignature2<ESIRequestOptions>} fn
  */
 async function getEVEStatus(fn) {
     const sdeVersion = await getSDEVersion();

package/esi-types-util.md

@@ -1,127 +0,0 @@
-<!--!
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
-  Released under the MIT license
-  https://opensource.org/licenses/mit-license.php
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
--->
-
-## ESI Types Utility Definitions
-
-### TESIRequestFunctionSignature
-
-`TESIRequestFunctionSignature<ActualOpt>` is a type that defines the signature of an ESI request function,  
-which sends a request to a specified endpoint and returns a response.
-
-```ts
-type TESIRequestFunctionSignature<ActualOpt> = <
-  M extends TESIEntryMethod,
-  EP extends keyof TESIResponseOKMap[M],
-  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>;
-```
-
-### IfParameterizedPath
-
-`IfParameterizedPath<EP, Opt>` if parameterized path then specify number type, otherwise will be `Opt` type.
-
-```ts
-type IfParameterizedPath<EP, Opt> = EP extends `${string}/{${string}}${string}`
-  ? PickPathParameters<EP> extends never
-    ? Opt : InferKeysLen<PickPathParameters<EP>> extends 1
-        ? number : [number, number]
-    : Opt;
-```
-
-### IdentifyParameters
-
-`IdentifyParameters<Entry, Opt>` is a type to identify the required parameters for a given entry type.
-
-```ts
-type IdentifyParameters<Entry, Opt> = Opt & Pick<Entry, Exclude<keyof Entry, "result">>;
-```
-
-### InferESIResponseResult
-
-`InferESIResponseResult<M extends TESIEntryMethod, EP extends keyof TESIResponseOKMap[M]>` is a type to infer the result type of an ESI response based on the method and endpoint.
-
-```ts
-type InferESIResponseResult<
-  M extends TESIEntryMethod,
-  EP extends keyof TESIResponseOKMap[M]
-> = TESIResponseOKMap[M][EP] extends { result: infer U } ? U : never;
-```
-
-### TESIEntryMethod
-
-`TESIEntryMethod` represents the HTTP methods supported by ESI.
-
-```ts
-type TESIEntryMethod = keyof TESIResponseOKMap;
-```
-
-### TEndPointGet
-
-`TEndPointGet` represents the endpoints for the "get" method.
-
-```ts
-type TEndPointGet = keyof TESIResponseOKMap["get"];
-```
-
-### TEndPointPost
-
-`TEndPointPost` represents the endpoints for the "post" method.
-
-```ts
-type TEndPointPost = keyof TESIResponseOKMap["post"];
-```
-
-### TEndPointPut
-
-`TEndPointPut` represents the endpoints for the "put" method.
-
-```ts
-type TEndPointPut = keyof TESIResponseOKMap["put"];
-```
-
-### TEndPointDelete
-
-`TEndPointDelete` represents the endpoints for the "delete" method.
-
-```ts
-type TEndPointDelete = keyof TESIResponseOKMap["delete"];
-```
-
-### TESIResponseGetEntry
-
-`TESIResponseGetEntry<K extends TEndPointGet>` represents the entry details for the "get" method.
-
-```ts
-type TESIResponseGetEntry<K extends TEndPointGet> = TESIResponseOKMap["get"][K];
-```
-
-### TESIResponsePutEntry
-
-`TESIResponsePutEntry<K extends TEndPointPut>` represents the entry details for the "put" method.
-
-```ts
-type TESIResponsePutEntry<K extends TEndPointPut> = TESIResponseOKMap["put"][K];
-```
-
-### TESIResponsePostEntry
-
-`TESIResponsePostEntry<K extends TEndPointPost>` represents the entry details for the "post" method.
-
-```ts
-type TESIResponsePostEntry<K extends TEndPointPost> = TESIResponseOKMap["post"][K];
-```
-
-### TESIResponseDeleteEntry
-
-`TESIResponseDeleteEntry<K extends TEndPointDelete>` represents the entry details for the "delete" method.
-
-```ts
-type TESIResponseDeleteEntry<K extends TEndPointDelete> = TESIResponseOKMap["delete"][K];
-```