eve-esi-types 3.2.4 → 3.2.7

package/lib/rq-util.d.mts

@@ -5,7 +5,7 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/// <reference types="../v2"/>
+/// <reference types="../dist/v2"/>
 // - - - - - - - - - - - - - - - - - - - -
 //               imports
 // - - - - - - - - - - - - - - - - - - - -
@@ -16,7 +16,7 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-import type { TESIRequestFunctionMethods2 } from "../v2";
+import type { TESIRequestFunctionMethods2 } from "../dist/v2";
 import type { TESIErrorStats } from "./esi-error-types";
 export { isNode } from "./constants.mjs";
 /**
@@ -27,7 +27,7 @@ export type Truthy = string | number | boolean;
 /**
  * __{Header}.{Payload}.{Signature}__
  */
-export type TAcccessToken = `${string}.${string}.${string}`;
+export type TAccessToken = `${string}.${string}.${string}`;
 export type ESIRequestOptions = {
     /**
      * query params for ESI request.
@@ -53,14 +53,45 @@ export type ESIRequestOptions = {
     /**
      * Can be an empty object if no authentication is required.description
      */
-    token?: TAcccessToken;
+    token?: TAccessToken;
     /**
      * cancel request immediately
      */
     cancelable?: AbortController;
 };
 /**
- * @typedef {string | number | boolean} Truthy
+ * type of the JWT token `payload` section
+ */
+export declare type TJWTPayload = {
+    /** scopes. */
+    scp: string[];
+    /** uuid of the token */
+    jti: string;
+    /** jwt type */
+    kid: string;
+    /** contains EVE character ID.
+     * ```
+     * "CHARACTER:EVE:<character_id>"
+     * ```
+     */
+    sub: `CHARACTER:EVE:${number}`;
+    /** Application client ID. */
+    azp: string;
+    /** EVE character name. */
+    name: string;
+    /** owner hash. */
+    owner: string;
+    /** expire date as 1/1000. (UNIX timestamp) */
+    exp: number;
+    /** issuer host name. */
+    iss: string;
+};
+/**
+ * @import * as ESIUtil from "./rq-util.mjs";
+ * @typedef {ESIUtil.Truthy} Truthy
+ * @typedef {ESIUtil.TAccessToken} TAccessToken
+ * @typedef {ESIUtil.TJWTPayload} TJWTPayload
+ * @typedef {ESIUtil.ESIRequestOptions} ESIRequestOptions
  */
 /**
  * simple named error class.
@@ -75,8 +106,12 @@ export declare class ESIErrorLimitReachedError extends ESIRequestError {
     valueOf(): number;
 }
 /**
- * @typedef {import("./rq-util.mjs").ESIRequestOptions} ESIRequestOptions
+ * @template T
+ * @template {Record<string, unknown>} O
+ * @param {[T] | [(T | undefined)?]} opt
+ * @returns {NonNullable<T> & O}
  */
+export declare const normalizeOptions: <T extends unknown, O extends Record<string, unknown> = ESIRequestOptions>(opt: [T] | [(T | undefined)?]) => (NonNullable<T> & O);
 /**
  * #### status: 200 | 201 | 204
  *
@@ -86,10 +121,11 @@ export declare class ESIErrorLimitReachedError extends ESIRequestError {
  * @param {string} endpointUrl
  * @param {RequestInit} requestOpt
  * @param {URLSearchParams} urlParams
- * @param {(minus?: Truthy) => void=} increment
+ * @param {(minus?: Truthy) => void=} progress
+ * @param {true=} allowFetchPages 2025/4/26
  * @returns {Promise<any>}
  */
-export declare const handleSuccessResponse: (response: Response, endpointUrl: string, requestOpt: RequestInit, urlParams: URLSearchParams, increment?: (minus?: Truthy) => void) => Promise<any>;
+export declare const handleSuccessResponse: (response: Response, endpointUrl: string, requestOpt: RequestInit, urlParams: URLSearchParams, progress?: (minus?: Truthy) => void, allowFetchPages?: true) => Promise<any>;
 /**
  * @import {
  *     TESIErrorStats,
@@ -146,11 +182,13 @@ export declare const initOptions: (method: string, opt: ESIRequestOptions) => {
  * @param {RequestInit} rqopt request options
  * @param {URLSearchParams} usp queries
  * @param {number} pc pageCount
- * @param {(minus?: number) => void=} increment
+ * @param {(minus?: number) => void=} progress
  * @returns {Promise<T | null>}
  */
-export declare const fetchP: <T extends unknown>(endpointUrl: string, rqopt: RequestInit, usp: URLSearchParams, pc: number, increment?: (minus?: Truthy) => void) => Promise<T | null>;
+export declare const fetchP: <T extends unknown>(endpointUrl: string, rqopt: RequestInit, usp: URLSearchParams, pc: number, progress?: (minus?: Truthy) => void) => Promise<T | null>;
 /** ### replace (C)urly (B)races (T)oken
+ *
+ * + Replace each `{…}` placeholder in the endpoint string with the corresponding ID.
  *
  * @example
  * "/characters/{character_id}/skills"
@@ -158,18 +196,39 @@ export declare const fetchP: <T extends unknown>(endpointUrl: string, rqopt: Req
  * "/characters/<char.character_id>/skills"
  *
  * @template {unknown} T
- * @param {T} endpoint e.g - "/characters/{character_id}/"
- * @param {number[]} ids
- * @returns {T} fragment of qualified endpoint uri or null.
+ * @param {T} endpoint An endpoint template, e.g. "/characters/{character_id}/skills"
+ * @param {number[]} ids An array of numbers to fill into each placeholder, in order of appearance
+ * @returns {T} A fully-qualified endpoint string with all `{…}` tokens replaced by their IDs
  */
 export declare const replaceCbt: <T extends unknown>(endpoint: T, ids: number[]) => T;
 /**
  * @template {unknown} T
- * @param {T} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
+ * @param {T} endpoint this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
  *   + The version parameter is forced to apply `latest`
  * @returns {string}
  */
-export declare const curl: <T extends unknown>(endp: T) => string;
+export declare const curl: <T extends unknown>(endpoint: T) => string;
+/**
+ * Type guard that checks whether the given object has a `pathParams` property
+ * of type `number` or `number[]`.
+ *
+ * @template {Record<string, unknown>} T - The type of the object being checked.
+ * @param {T} opt - The object to inspect.
+ * @returns {opt is (T & { pathParams: number | number[] })}
+ *   `true` if `opt` contains a `pathParams` property whose value is either
+ *   a single number or an array of numbers, otherwise `false`.
+ *
+ * @date 2025/4/28
+ */
+export declare function hasPathParams<T extends Record<string, unknown>>(opt: T): opt is (T & {
+    pathParams: number | number[];
+});
+/**
+ *
+ * @param {string} accessToken OAuth 2.0 access token
+ * @returns {TJWTPayload}
+ */
+export declare const getJWTPayload: (accessToken: string) => TJWTPayload;
 /**
  * @date 2020/03/31
  * @version 2.1
@@ -188,6 +247,8 @@ type TPrependParams = TESIRequestFunctionSignature2<ESIRequestOptions> | TESIReq
 /**
  * #### Fire a request that does not require authentication.
  *
+ * + __CAVEAT:__ This function should only be used for testing.
+ *
  * @param {TPrependParams} fn
  * @returns {Promise<void>}
  */

package/lib/rq-util.mjs

@@ -5,7 +5,7 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/// <reference types="../v2"/>
+/// <reference types="../dist/v2"/>
 // - - - - - - - - - - - - - - - - - - - -
 //               imports
 // - - - - - - - - - - - - - - - - - - - -
@@ -27,7 +27,11 @@ let LOG = false;
  */
 export const BASE = "https://esi.evetech.net";
 /**
- * @typedef {string | number | boolean} Truthy
+ * @import * as ESIUtil from "./rq-util.mjs";
+ * @typedef {ESIUtil.Truthy} Truthy
+ * @typedef {ESIUtil.TAccessToken} TAccessToken
+ * @typedef {ESIUtil.TJWTPayload} TJWTPayload
+ * @typedef {ESIUtil.ESIRequestOptions} ESIRequestOptions
  */
 /**
  * simple named error class.
@@ -45,12 +49,24 @@ export class ESIErrorLimitReachedError extends ESIRequestError {
         return 420;
     }
 }
-/**
- * @typedef {import("./rq-util.mjs").ESIRequestOptions} ESIRequestOptions
- */
 // - - - - - - - - - - - - - - - - - - - -
 //            utility functions
 // - - - - - - - - - - - - - - - - - - - -
+/**
+ * @template T
+ * @template {Record<string, unknown>} O
+ * @param {[T] | [(T | undefined)?]} opt
+ * @returns {NonNullable<T> & O}
+ */
+export const normalizeOptions = (opt) => {
+    //* ctt
+    return /** @type {NonNullable<T> & O} */ (opt.length ? (opt[0] ?? {}) : {});
+    /*/
+    const r = /** @type {NonNullable<T>} * /(opt.length ? (opt[0] ?? {}): {}) as NonNullable<T>;
+    log(`normalizeOptions::[${JSON.stringify(r)}]`);
+    return r;
+    //*/
+};
 /**
  * #### status: 200 | 201 | 204
  *
@@ -60,30 +76,33 @@ export class ESIErrorLimitReachedError extends ESIRequestError {
  * @param {string} endpointUrl
  * @param {RequestInit} requestOpt
  * @param {URLSearchParams} urlParams
- * @param {(minus?: Truthy) => void=} increment
+ * @param {(minus?: Truthy) => void=} progress
+ * @param {true=} allowFetchPages 2025/4/26
  * @returns {Promise<any>}
  */
-export const handleSuccessResponse = async (response, endpointUrl, requestOpt, urlParams, increment = () => { }) => {
+export const handleSuccessResponse = async (response, endpointUrl, requestOpt, urlParams, progress = () => { }, allowFetchPages) => {
     // NoContentResponse
     if (response.status === 204)
         return {};
     /** @type {any} */
     const data = await response.json();
-    // - - - - x-pages response.
-    // +undefined is NaN
-    // @ts-expect-error becouse +null is 0
-    const pc = +response.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, requestOpt, urlParams, pc, increment);
-        // finally, decide product data.
-        if (isArray(data) && isArray(remData)) {
-            // DEVNOTE: 2019/7/23 15:01:48 - types
-            return data.concat(remData);
-        }
-        else {
-            remData && Object.assign(data, remData);
+    if (allowFetchPages) {
+        // - - - - x-pages response.
+        // +undefined is NaN
+        // @ts-expect-error becouse +null is 0
+        const pc = +response.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, requestOpt, urlParams, pc, progress);
+            // finally, decide product data.
+            if (isArray(data) && isArray(remData)) {
+                // DEVNOTE: 2019/7/23 15:01:48 - types
+                return data.concat(remData);
+            }
+            else {
+                remData && Object.assign(data, remData);
+            }
         }
     }
     return data;
@@ -214,6 +233,9 @@ export const initOptions = (method, opt) => {
             qss[key] = oqs[key];
     }
     if (opt.auth) {
+        if (!opt.token) {
+            throw new Error("Authentication required: missing `token`");
+        }
         // @ts-ignore The header is indeed an object
         rqopt.headers.authorization = `Bearer ${opt.token}`;
     }
@@ -233,19 +255,19 @@ export const initOptions = (method, opt) => {
  * @param {RequestInit} rqopt request options
  * @param {URLSearchParams} usp queries
  * @param {number} pc pageCount
- * @param {(minus?: number) => void=} increment
+ * @param {(minus?: number) => void=} progress
  * @returns {Promise<T | null>}
  */
-export const fetchP = async (endpointUrl, rqopt, usp, pc, increment = () => { }) => {
+export const fetchP = async (endpointUrl, rqopt, usp, pc, progress = () => { }) => {
     const rqs = [];
     for (let i = 2; i <= pc;) {
         usp.set("page", (i++) + "");
-        increment();
+        progress();
         rqs.push(fetch(`${endpointUrl}?${usp + ""}`, rqopt).then(res => res.json()).catch(reason => {
             console.warn(reason);
             return [];
         }).finally(() => {
-            increment(1);
+            progress(1);
         }));
     }
     return Promise.all(rqs).then(jsons => {
@@ -262,7 +284,10 @@ export const fetchP = async (endpointUrl, rqopt, usp, pc, increment = () => { })
         return null;
     });
 };
+const CBT_RE = /{\w+}/g;
 /** ### replace (C)urly (B)races (T)oken
+ *
+ * + Replace each `{…}` placeholder in the endpoint string with the corresponding ID.
  *
  * @example
  * "/characters/{character_id}/skills"
@@ -270,24 +295,51 @@ export const fetchP = async (endpointUrl, rqopt, usp, pc, increment = () => { })
  * "/characters/<char.character_id>/skills"
  *
  * @template {unknown} T
- * @param {T} endpoint e.g - "/characters/{character_id}/"
- * @param {number[]} ids
- * @returns {T} fragment of qualified endpoint uri or null.
+ * @param {T} endpoint An endpoint template, e.g. "/characters/{character_id}/skills"
+ * @param {number[]} ids An array of numbers to fill into each placeholder, in order of appearance
+ * @returns {T} A fully-qualified endpoint string with all `{…}` tokens replaced by their IDs
  */
 export const replaceCbt = (endpoint, ids) => {
     let idx = 0;
-    // @ts-expect-error
-    return endpoint.replace(/{([\w]+)}/g, () => ids[idx++] + "");
+    return /** @type {T} */ (/** @type {string} */ (endpoint).replace(CBT_RE, () => String(ids[idx++])));
 };
 /**
  * @template {unknown} T
- * @param {T} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
+ * @param {T} endpoint this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
  *   + The version parameter is forced to apply `latest`
  * @returns {string}
  */
-export const curl = (endp) => {
-    // @ts-expect-error
-    return `${BASE}/latest/${endp.replace(/^\/+|\/+$/g, "")}/`;
+export const curl = (endpoint) => {
+    return `${BASE}/latest/${/** @type {string} */ (endpoint).replace(/^\/+|\/+$/g, "")}/`;
+};
+/**
+ * Type guard that checks whether the given object has a `pathParams` property
+ * of type `number` or `number[]`.
+ *
+ * @template {Record<string, unknown>} T - The type of the object being checked.
+ * @param {T} opt - The object to inspect.
+ * @returns {opt is (T & { pathParams: number | number[] })}
+ *   `true` if `opt` contains a `pathParams` property whose value is either
+ *   a single number or an array of numbers, otherwise `false`.
+ *
+ * @date 2025/4/28
+ */
+export function hasPathParams(opt) {
+    if (typeof opt !== "object" || opt === null)
+        return false;
+    return "pathParams" in opt && (typeof opt.pathParams === "number" || Array.isArray(opt.pathParams));
+}
+/**
+ *
+ * @param {string} accessToken OAuth 2.0 access token
+ * @returns {TJWTPayload}
+ */
+export const getJWTPayload = (accessToken) => {
+    // const [header, payload, sig] = accessToken.split(".");
+    // const headerJson = a2b(header); maybe always {"alg":"RS256","kid":"JWT-Signature-Key","typ":"JWT"}
+    // const sigJson = a2b(sig);
+    const json = atob(accessToken.split(".")[1]);
+    return JSON.parse(json); // as NsEVEOAuth.TJWTPayload;
 };
 /**
  * @date 2020/03/31
@@ -326,7 +378,7 @@ export function getLogger() {
 }
 /**
  * Need typescript v5.5 later
- * @import * as ESI from "../v2";
+ * @import * as ESI from "../dist/v2";
  * @typedef {ESI.TESIRequestFunctionMethods2<ESIRequestOptions>} TESIRequestFunctionMethods2
  */
 /**
@@ -337,24 +389,43 @@ export function getLogger() {
  *
  * @type {TESIEnhancedRequestFunctionSignature<TPrependParams, ESIRequestOptions>}
  */
+// @ts-ignore ts(2322) ignore on ts file, bad js file is OK?
 const fireWithoutAuth = (fn, method, endpoint, ...opt) => {
+    const arg = opt.length ? opt[0] : void 0;
     if (typeof fn === "function") {
-        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);
     }
     // @ts-expect-error TODO: ts(2345) The argument type does not match the type of the specified parameter
-    return fn[method](endpoint, ...opt);
+    return fn[method](endpoint, arg);
 };
-const token = `token.token.token`;
+// /**
+//  * ```
+//  * process.env.CID // Specify EVE Character id
+//  * process.env.OAUTH_TOKEN // Spedify valid OAuth token
+//  * ```
+//  * @param envName
+//  */
+// const getEnvValue = (envName: string) => process.env[envName] ?? null;
+/** @type {TAccessToken} */
+const token = /** @type {TAccessToken} */ (process.env.OAUTH_TOKEN ?? "token.token.token");
+const ID_SomeEVECharacter = (() => {
+    if (token !== "token.token.token") {
+        const payload = getJWTPayload(token);
+        return +payload.sub.split(":")[2];
+    }
+    return 9000;
+})();
 /**
  * #### Fire a request that does not require authentication.
  *
+ * + __CAVEAT:__ This function should only be used for testing.
+ *
  * @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 {
         // - - - - - - - - - - - -
@@ -377,17 +448,21 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
             rlog("get:/incursions/".green);
             await fireWithoutAuth(fn, "get", "/incursions/").then(log);
             if (is("withError")) {
+                log(`Try character ${ID_SomeEVECharacter} assets request`);
                 await fireWithoutAuth(fn, "get", "/characters/{character_id}/assets/", {
-                    auth: true,
+                    auth: true, token,
                     pathParams: ID_SomeEVECharacter,
-                    token
                 }).then(assets => {
                     log(assets.slice(0, 5));
                 });
-                await fireWithoutAuth(fn, "delete", `/characters/${1234}/fittings/${56789}/`, {
+                log(`Try character ${ID_SomeEVECharacter} fittings request`);
+                await fireWithoutAuth(fn, "get", `/characters/${ID_SomeEVECharacter}/fittings/`, {
                     auth: true,
-                    // pathParams: [1234, 56789], // ✅ At this point, the expected semantic error is successfully triggered as intended.
-                }).catch(log);
+                    // pathParams: [ID_SomeEVECharacter, 56789], // ✅ At this point, the expected semantic error is successfully triggered as intended.
+                    token
+                }).then(fittings => {
+                    log(fittings.slice(0, 5));
+                });
             }
         }
         // - - - - - - - - - - - -
@@ -420,8 +495,7 @@ export async function fireRequestsDoesNotRequireAuth(fn) {
         //  Authentication is required, so an error will occur.
         // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
         let willFailed = await fireWithoutAuth(fn, "get", `/characters/${ID_SomeEVECharacter}/ship/`, {
-            auth: true,
-            token //: "token.token.token"
+            auth: true, token
         });
         log(`get:/characters/${ID_SomeEVECharacter}/ship/, returns:`, willFailed);
         // in this case, "categories" and "search" is required

package/lib/tagged-request-api.d.mts

@@ -5,7 +5,7 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/// <reference types="../v2/esi-tagged-types"/>
+/// <reference types="../dist/v2/esi-tagged-types"/>
 import type { ESIRequestOptions } from "./rq-util.mjs";
 /**
  * Decorates the ESI request body into a tagged ESI request map.
@@ -30,4 +30,4 @@ export declare function decoreateESIRequestBody<Opt extends Record<string, unkno
  * @since 2.x
  * @type {XESI.TaggedESIRequestMap2<ESIRequestOptions>}
  */
-export declare const esi: import("../v2/esi-tagged-types").TaggedESIRequestMap2<ESIRequestOptions>;
+export declare const esi: import("../dist/v2/esi-tagged-types").TaggedESIRequestMap2<ESIRequestOptions>;

package/lib/tagged-request-api.mjs

@@ -5,13 +5,13 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/// <reference types="../v2/esi-tagged-types"/>
+/// <reference types="../dist/v2/esi-tagged-types"/>
 /**
  * @file eve-esi-types/lib/tagged-request-api.mts
  */
 import { request2 } from "./request-api.mjs";
 /**
- * @import { TESIRequestFunctionMethods2 } from "../v2"
+ * @import { TESIRequestFunctionMethods2 } from "../dist/v2"
  */
 /**
  * @typedef {`${string}${"" | `,${string}`}`} TMethodList

package/minimal-rq.mjs

@@ -5,7 +5,7 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/// <reference types="./v2"/>
+/// <reference types="./dist/v2"/>
 // - - - - - - - - - - - - - - - - - - - -
 //               imports
 // - - - - - - - - - - - - - - - - - - - -
@@ -17,8 +17,8 @@ import { request2 } from "./lib/request-api.mjs";
 // shorthands
 const log = util.getUniversalLogger("[request-mini]: ");
 /**
- * @typedef {import("./v2").IESIRequestFunction2<util.ESIRequestOptions>} IESIRequestFunction2
- * @typedef {import("./v2").TESIRequestFunctionMethods2<util.ESIRequestOptions>} TESIRequestFunctionMethods2
+ * @typedef {import("./dist/v2").IESIRequestFunction2<util.ESIRequestOptions>} IESIRequestFunction2
+ * @typedef {import("./dist/v2").TESIRequestFunctionMethods2<util.ESIRequestOptions>} TESIRequestFunctionMethods2
  */
 // - - - - - - - - - - - - - - - - - - - -
 //            main functions
@@ -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, /** @type {Parameters<typeof request2>[2]} */ (opt));
+        // @ts-expect-error ts(2345)
+        return request2(method, endpoint, opt);
     });
 });
 // It should complete correctly.

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "eve-esi-types",
-  "version": "3.2.4",
+  "version": "3.2.7",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
-  "main": "v2/index.d.ts",
+  "main": "dist/v2/index.d.ts",
   "scripts": {
-    "start": "tsc -p jsconfig.json",
+    "start": "tsc",
     "test": "node request-v3.mjs -debug",
     "test:mini": "node minimal-rq.mjs -debug"
   },
@@ -13,7 +13,7 @@
     "url": "git+ssh://git@github.com/jeffy-g/eve-esi-types.git"
   },
   "files": [
-    "v2",
+    "dist",
     "lib",
     "web",
     "*.d.mts",
@@ -21,7 +21,7 @@
     "LICENSE",
     "*.md",
     "package.json",
-    "jsconfig.json"
+    "tsconfig.json"
   ],
   "keywords": [
     "api",

package/request-v3.d.mts

@@ -1,11 +1,4 @@
-/*!
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
-  Released under the MIT license
-  https://opensource.org/licenses/mit-license.php
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-*/
-import { type ESIRequestOptions } from "./lib/rq-util.mjs";
+import type { ESIRequestOptions } from "./lib/rq-util.mjs";
 /**
  * @returns Get The Current ESI request pending count.
  */

package/request-v3.mjs

@@ -5,13 +5,15 @@
   https://opensource.org/licenses/mit-license.php
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/// <reference types="./v2"/>
+/**
+ * @file request-v3.mts
+ * @command node request-v3.mjs
+ */
+/// <reference types="./dist/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";
+import { is, curl, replaceCbt, hasPathParams, getSDEVersion, normalizeOptions, initOptions, isDebug, fireRequestsDoesNotRequireAuth, isSuccess, handleESIError, handleSuccessResponse, } from "./lib/rq-util.mjs";
 // - - - - - - - - - - - - - - - - - - - -
 //           constants, types
 // - - - - - - - - - - - - - - - - - - - -
@@ -21,9 +23,8 @@ const isArray = Array.isArray;
 /**
  * enable/disable console.log
  */
-let LOG = isDebug();
+const 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
@@ -36,7 +37,7 @@ let LOG = isDebug();
  */
 let ax = 0;
 /** @type {function(Truthy=): number} */
-const incrementAx = (minus) => minus ? ax-- : ax++;
+const progress = (minus) => minus ? ax-- : ax++;
 /**
  * @returns Get The Current ESI request pending count.
  */
@@ -50,18 +51,14 @@ export const getRequestPending = () => ax;
  * @throws {ESIRequestError}
  * @async
  */
-export const fire = /** @type {TESIRequestFunctionSignature2<ESIRequestOptions>} */ (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)) {
+export const fire = /** @type {TESIRequestFunctionSignature2<ESIRequestOptions>} */ (async (mthd, endp, ...opt) => {
+    // When only options are provided
+    const nOpt = normalizeOptions(opt);
+    if (hasPathParams(nOpt)) {
+        const pathParams = Array.isArray(nOpt.pathParams) ? nOpt.pathParams : [nOpt.pathParams];
         endp = replaceCbt(endp, pathParams);
     }
-    // When only options are provided
-    const actualOpt = opt || /** @type {NonNullable<typeof opt>} */ ({});
-    const { rqopt, qss } = initOptions(mthd, actualOpt);
+    const { rqopt, qss } = initOptions(mthd, nOpt);
     const endpointUrl = curl(endp);
     const up = new URLSearchParams(qss);
     const url = `${endpointUrl}${up.size ? `?${up}` : ""}`;
@@ -71,11 +68,11 @@ export const fire = /** @type {TESIRequestFunctionSignature2<ESIRequestOptions>}
         const res = await fetch(url, rqopt).finally(() => ax--);
         // The parameters are different for successful and error responses.
         if (isSuccess(res.status)) {
-            return handleSuccessResponse(res, endpointUrl, rqopt, up, incrementAx);
+            return handleSuccessResponse(res, endpointUrl, rqopt, up, progress);
         }
         // else if (isError(status)) {}
         // Actually, throw Error
-        throw await handleESIError(res, endpointUrl, actualOpt.cancelable);
+        throw await handleESIError(res, endpointUrl, nOpt.cancelable);
     }
     catch (e) {
         throw e;