eve-esi-types 2.2.0 → 2.2.4

package/esi-types-util.md

@@ -8,19 +8,34 @@
 
 ## ESI Types Utility Definitions
 
-### IsParameterizedPath
+### TESIRequestFunctionSignature
 
-`IsParameterizedPath<EP, A, B>` is a type to determine if a path is parameterized. If it is, it returns `A`, otherwise it returns `B`.
+`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.
 
-```typescript
-type IsParameterizedPath<EP, A, B> = EP extends `${string}/{${string}}/${string | ""}` ? A : B;
+```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 | ""}` ? number | number[]: Opt;
 ```
 
 ### IdentifyParameters
 
 `IdentifyParameters<Entry, Opt>` is a type to identify the required parameters for a given entry type.
 
-```typescript
+```ts
 type IdentifyParameters<Entry, Opt> = Opt & Pick<Entry, Exclude<keyof Entry, "result">>;
 ```
 
@@ -28,7 +43,7 @@ type IdentifyParameters<Entry, Opt> = Opt & Pick<Entry, Exclude<keyof Entry, "re
 
 `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.
 
-```typescript
+```ts
 type InferESIResponseResult<
   M extends TESIEntryMethod,
   EP extends keyof TESIResponseOKMap[M]
@@ -39,7 +54,7 @@ type InferESIResponseResult<
 
 `TESIEntryMethod` represents the HTTP methods supported by ESI.
 
-```typescript
+```ts
 type TESIEntryMethod = keyof TESIResponseOKMap;
 ```
 
@@ -47,7 +62,7 @@ type TESIEntryMethod = keyof TESIResponseOKMap;
 
 `TEndPointGet` represents the endpoints for the "get" method.
 
-```typescript
+```ts
 type TEndPointGet = keyof TESIResponseOKMap["get"];
 ```
 
@@ -55,7 +70,7 @@ type TEndPointGet = keyof TESIResponseOKMap["get"];
 
 `TEndPointPost` represents the endpoints for the "post" method.
 
-```typescript
+```ts
 type TEndPointPost = keyof TESIResponseOKMap["post"];
 ```
 
@@ -63,7 +78,7 @@ type TEndPointPost = keyof TESIResponseOKMap["post"];
 
 `TEndPointPut` represents the endpoints for the "put" method.
 
-```typescript
+```ts
 type TEndPointPut = keyof TESIResponseOKMap["put"];
 ```
 
@@ -71,7 +86,7 @@ type TEndPointPut = keyof TESIResponseOKMap["put"];
 
 `TEndPointDelete` represents the endpoints for the "delete" method.
 
-```typescript
+```ts
 type TEndPointDelete = keyof TESIResponseOKMap["delete"];
 ```
 
@@ -79,7 +94,7 @@ type TEndPointDelete = keyof TESIResponseOKMap["delete"];
 
 `TESIResponseGetEntry<K extends TEndPointGet>` represents the entry details for the "get" method.
 
-```typescript
+```ts
 type TESIResponseGetEntry<K extends TEndPointGet> = TESIResponseOKMap["get"][K];
 ```
 
@@ -87,7 +102,7 @@ type TESIResponseGetEntry<K extends TEndPointGet> = TESIResponseOKMap["get"][K];
 
 `TESIResponsePutEntry<K extends TEndPointPut>` represents the entry details for the "put" method.
 
-```typescript
+```ts
 type TESIResponsePutEntry<K extends TEndPointPut> = TESIResponseOKMap["put"][K];
 ```
 
@@ -95,7 +110,7 @@ type TESIResponsePutEntry<K extends TEndPointPut> = TESIResponseOKMap["put"][K];
 
 `TESIResponsePostEntry<K extends TEndPointPost>` represents the entry details for the "post" method.
 
-```typescript
+```ts
 type TESIResponsePostEntry<K extends TEndPointPost> = TESIResponseOKMap["post"][K];
 ```
 
@@ -103,6 +118,6 @@ type TESIResponsePostEntry<K extends TEndPointPost> = TESIResponseOKMap["post"][
 
 `TESIResponseDeleteEntry<K extends TEndPointDelete>` represents the entry details for the "delete" method.
 
-```typescript
+```ts
 type TESIResponseDeleteEntry<K extends TEndPointDelete> = TESIResponseOKMap["delete"][K];
 ```

package/minimal-rq.d.mts

@@ -0,0 +1,29 @@
+/*!
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+//  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
+//  Released under the MIT license
+//  https://opensource.org/licenses/mit-license.php
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+import * as util from "./rq-util.mjs";
+import type { IESIRequestFunction } from "./v2";
+/**
+ * @typedef {import("./v2").TESIResponseOKMap} TESIResponseOKMap
+ * @typedef {import("./rq-util.mjs").ESIRequestOptions} ESIRequestOptions
+ * @typedef {import("./v2").IESIRequestFunction<util.ESIRequestOptions>} IESIRequestFunction
+ * @typedef {import("./v2").TESIRequestFunctionMethods<util.ESIRequestOptions>} TESIRequestFunctionMethods
+ */
+/** #### Sample of `TESIRequestFunctionSignature`
+ *
+ * + This is a minimal implementation using `TESIRequestFunctionSignature`.
+ *   If the response contains "page", only the first page can be retrieved.
+ *
+ * @type {IESIRequestFunction}
+ * @param method - The HTTP method to use for the request
+ * @param endpoint - The Path of the ESI endpoint to send the request to
+ * @param pathParams - An object of parameters to include in the request
+ * @param options - An object of options to include in the request
+ * @returns A Promise object containing the response data
+ * @throws {ESIRequesError}
+ */
+export declare const request: IESIRequestFunction<util.ESIRequestOptions>;

package/minimal-rq.mjs

@@ -0,0 +1,134 @@
+/*!
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+//  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 * as util from "./rq-util.mjs";
+// - - - - - - - - - - - - - - - - - - - -
+//           constants, types
+// - - - - - - - - - - - - - - - - - - - -
+// shorthands
+const log = console.log;
+const DEBUG = util.isDebug();
+/**
+ * @typedef {import("./v2").TESIResponseOKMap} TESIResponseOKMap
+ * @typedef {import("./rq-util.mjs").ESIRequestOptions} ESIRequestOptions
+ * @typedef {import("./v2").IESIRequestFunction<util.ESIRequestOptions>} IESIRequestFunction
+ * @typedef {import("./v2").TESIRequestFunctionMethods<util.ESIRequestOptions>} TESIRequestFunctionMethods
+ */
+// - - - - - - - - - - - - - - - - - - - -
+//            main functions
+// - - - - - - - - - - - - - - - - - - - -
+/** #### Sample of `TESIRequestFunctionSignature`
+ *
+ * + This is a minimal implementation using `TESIRequestFunctionSignature`.
+ *   If the response contains "page", only the first page can be retrieved.
+ *
+ * @type {IESIRequestFunction}
+ * @param method - The HTTP method to use for the request
+ * @param endpoint - The Path of the ESI endpoint to send the request to
+ * @param pathParams - An object of parameters to include in the request
+ * @param options - An object of options to include in the request
+ * @returns A Promise object containing the response data
+ * @throws {ESIRequesError}
+ */
+// @ts-expect-error
+export const request = (method, endpoint, pathParams, opt) => {
+    if (typeof pathParams === "number") {
+        // @ts-expect-error
+        pathParams = [pathParams];
+    }
+    if (Array.isArray(pathParams)) {
+        // @ts-expect-error actualy endp is string
+        endpoint = util.replaceCbt(endpoint, pathParams);
+    }
+    // When only options are provided
+    const actualOpt = /** @type {NonNullable<typeof opt>} */ (opt || pathParams || {});
+    const { rqopt, qss } = util.initOptions(method, actualOpt);
+    // @ts-expect-error actualy endp is string
+    const endpointUrl = util.curl(endpoint);
+    const up = new URLSearchParams(qss);
+    const url = `${endpointUrl}${up.size ? `?${up}` : ""}`;
+    DEBUG && log(url);
+    return fetch(url, rqopt).then(res => res.json()).catch(reason => {
+        throw new util.ESIRequesError(reason.message ? reason.message : reason);
+    });
+};
+//
+// implements rest methods of `request` (IESIRequestFunction)
+//
+/** @type {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
+    request[method] = /** @type {TESIRequestFunctionEachMethod<typeof method>} */ (function (endpoint, params, opt) {
+        return this(method, endpoint, params, opt);
+    });
+});
+//
+// Delegates implementation to `request` (TESIRequestFunctionMethods)
+//
+const esiMethods = /** @type {TESIRequestFunctionMethods} */ ({});
+["get", "post", "put", "delete"].forEach((method) => {
+    esiMethods[method] = function (endpoint, params, opt) {
+        // @ts-ignore
+        return request(method, endpoint, params, opt);
+    };
+});
+// It should complete correctly.
+/**
+ * @param {IESIRequestFunction} fn
+ */
+async function getEVEStatus(fn) {
+    await util.getSDEVersion().then(sdeVersion => log(`sdeVersion: ${sdeVersion}`.blue));
+    await util.fireRequestsDoesNotRequireAuth(fn);
+    CaseIESIRequestFunctionMethods: {
+        await util.fireRequestsDoesNotRequireAuth(esiMethods);
+    }
+    const { clog, rlog } = util.getLogger();
+    CaseIESIRequestFunction: {
+        // - - - - - - - - - - - -
+        //       Character
+        // - - - - - - - - - - - -
+        // Here, I borrow data from "CCP Zoetrope".
+        rlog("- - - - - - - > run as IESIRequestFunction<ESIRequestOptions>".red);
+        clog();
+        await fn.get("/characters/{character_id}/", 2112625428).then(log);
+        clog('(portrait)');
+        await fn.get("/characters/{character_id}/portrait/", 2112625428).then(log);
+        clog('(affiliation)');
+        const affiliation = await fn.post("/characters/affiliation/", { body: [2112625428] });
+        log(affiliation);
+        clog('(corporation)');
+        await fn.get("/corporations/{corporation_id}/", affiliation[0].corporation_id).then(log);
+        rlog("get:/incursions/".green);
+        await fn.get("/incursions/").then(log);
+        // - - - - - - - - - - - -
+        //     Miscellaneous
+        // - - - - - - - - - - - -
+        rlog("post:/universe/ids/".green);
+        const ids = await fn.post("/universe/ids/", { body: ["the forge", "plex"] });
+        log(ids.inventory_types, ids.regions);
+        rlog(`get:/markets/${ids?.regions?.[0].id}/orders/?type_id=${ids?.inventory_types?.[0].id}, item PLEX`.green);
+        const orders = await fn.get("/markets/{region_id}/orders/", ids?.regions?.[0].id, {
+            query: {
+                // page: 1,
+                order_type: "sell",
+                type_id: ids?.inventory_types?.[0].id
+            }
+        });
+        log(orders.sort((a, b) => a.price - b.price).slice(0, 2));
+    }
+    return fn.get("/status/");
+}
+// type following and run
+// node minimal-rq.mjs -debug
+getEVEStatus(request).then(eveStatus => log(eveStatus));
+// {
+//     "players": 16503,
+//     "server_version": "2794925",
+//     "start_time": "2025-01-21T11:02:34Z"
+// }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "eve-esi-types",
-  "version": "2.2.0",
+  "version": "2.2.4",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
   "main": "v2/index.d.ts",
   "scripts": {
-    "test": "node v2.mjs"
+    "test": "node v2.mjs -debug",
+    "test:mini": "node minimal-rq.mjs -debug"
   },
   "repository": {
     "type": "git",
@@ -12,10 +13,8 @@
   },
   "files": [
     "v2",
-    "v2.mjs",
-    "v2.d.mts",
-    "rq-util.mjs",
-    "rq-util.d.mts",
+    "*.d.mts",
+    "*.mjs",
     "LICENSE",
     "*.md",
     "package.json",
@@ -35,5 +34,8 @@
   "bugs": {
     "url": "https://github.com/jeffy-g/eve-esi-types/issues"
   },
-  "homepage": "https://github.com/jeffy-g/eve-esi-types#readme"
+  "homepage": "https://github.com/jeffy-g/eve-esi-types#readme",
+  "devDependencies": {
+    "colors.ts": "^1.0.20"
+  }
 }

package/rq-util.d.mts

@@ -5,9 +5,8 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/**
- * @file rq-util.d.mts
- */
+import "colors.ts";
+import type { TESIRequestFunctionMethods } from "./v2";
 /**
  * this always `https://esi.evetech.net`
  */
@@ -38,6 +37,13 @@ export type ESIRequestOptions = {
      * Can be an empty object if no authentication is required.description
      */
     token?: TAcccessToken;
+    /**
+     * whether an authorization header is required
+     *
+     *   + When using the `Web Fetch API`, avoid extra `OPTIONS` requests and reduce extra http requests
+     *
+     * @date 2020/1/23
+     */
     auth?: true;
 };
 /**
@@ -52,6 +58,19 @@ export declare class ESIErrorLimitReachedError extends ESIRequesError {
     constructor();
     valueOf(): number;
 }
+/**
+ * @typedef {import("./rq-util.mjs").ESIRequestOptions} ESIRequestOptions
+ */
+export declare const isDebug: () => boolean;
+/**
+ * @param {string} method
+ * @param {ESIRequestOptions} opt
+ * @returns
+ */
+export declare const initOptions: (method: string, opt: ESIRequestOptions) => {
+    rqopt: RequestInit;
+    qss: Record<string, string>;
+};
 /**
  * fetch the extra pages
  *
@@ -59,11 +78,11 @@ export declare class ESIErrorLimitReachedError extends ESIRequesError {
  *
  * @param {string} endpointUrl
  * @param {RequestInit} rqopt request options
- * @param {Record<string, any>} qs queries
+ * @param {URLSearchParams} rqp queries
  * @param {number} pc pageCount
  * @param {(minus?: number) => void=} increment
  */
-export declare const fetchP: <T extends unknown>(endpointUrl: string, rqopt: RequestInit, qs: Record<string, any>, pc: number, increment?: (minus?: Truthy) => void) => Promise<T | null>;
+export declare const fetchP: <T extends unknown>(endpointUrl: string, rqopt: RequestInit, rqp: URLSearchParams, pc: number, increment?: (minus?: Truthy) => void) => Promise<T | null>;
 /** ### replace (C)urly (B)races (T)oken
  *
  * @example
@@ -79,6 +98,22 @@ export declare const replaceCbt: (endpoint: string, ids: number[]) => string;
 /**
  *
  * @param {string} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
- *   + The version parameter can be omitted by using `<version>/<endpoint>`
+ *   + The version parameter is forced to apply `latest`
  */
 export declare const curl: (endp: string) => string;
+/**
+ * @date 2020/03/31
+ * @version 2.1
+ * @type {() => Promise<string>}
+ */
+export declare function getSDEVersion(): Promise<string>;
+export declare function getLogger(): {
+    clog: (...args: any[]) => void;
+    rlog: (...args: any[]) => void;
+};
+/**
+ * #### Fire a request that does not require authentication.
+ *
+ * @param {TESIRequestFunctionSignature<ESIRequestOptions> | TESIRequestFunctionMethods} fn
+ */
+export declare function fireRequestsDoesNotRequireAuth(fn: TESIRequestFunctionSignature<ESIRequestOptions> | TESIRequestFunctionMethods<ESIRequestOptions>): Promise<void>;

package/rq-util.mjs

@@ -5,9 +5,11 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-/**
- * @file rq-util.d.mts
- */
+/// <reference types="./v2"/>
+// - - - - - - - - - - - - - - - - - - - -
+//               imports
+// - - - - - - - - - - - - - - - - - - - -
+import "colors.ts";
 // - - - - - - - - - - - - - - - - - - - -
 //           constants, types
 // - - - - - - - - - - - - - - - - - - - -
@@ -38,6 +40,48 @@ export class ESIErrorLimitReachedError extends ESIRequesError {
         return 420;
     }
 }
+/**
+ * @typedef {import("./rq-util.mjs").ESIRequestOptions} ESIRequestOptions
+ */
+// - - - - - - - - - - - - - - - - - - - -
+//            utility functions
+// - - - - - - - - - - - - - - - - - - - -
+export const isDebug = () => {
+    return process.argv.includes("-debug");
+};
+/**
+ * @param {string} method
+ * @param {ESIRequestOptions} opt
+ * @returns
+ */
+export const initOptions = (method, opt) => {
+    /** @type {RequestInit} */
+    const rqopt = {
+        method,
+        mode: "cors",
+        cache: "no-cache",
+        signal: opt.cancelable?.signal,
+        headers: {}
+    };
+    const qss = {
+    // language: "en",
+    };
+    if (opt.query) {
+        // Object.assign(query, options.query); Object.assign is too slow
+        const oqs = opt.query;
+        Object.keys(oqs).forEach(k => qss[k] = oqs[k]);
+    }
+    if (opt.auth) {
+        // @ts-ignore The header is indeed an object
+        rqopt.headers.authorization = `Bearer ${opt.token}`;
+    }
+    if (opt.body) { // means "POST" method etc
+        // @ts-ignore The header is indeed an object
+        rqopt.headers["content-type"] = "application/json";
+        rqopt.body = JSON.stringify(opt.body);
+    }
+    return { rqopt, qss };
+};
 /**
  * fetch the extra pages
  *
@@ -45,13 +89,12 @@ export class ESIErrorLimitReachedError extends ESIRequesError {
  *
  * @param {string} endpointUrl
  * @param {RequestInit} rqopt request options
- * @param {Record<string, any>} qs queries
+ * @param {URLSearchParams} rqp queries
  * @param {number} pc pageCount
  * @param {(minus?: number) => void=} increment
  */
-export const fetchP = async (endpointUrl, rqopt, qs, pc, increment = () => { }) => {
+export const fetchP = async (endpointUrl, rqopt, rqp, pc, increment = () => { }) => {
     const rqs = [];
-    const rqp = new URLSearchParams(qs);
     for (let i = 2; i <= pc;) {
         rqp.set("page", (i++) + "");
         increment();
@@ -99,9 +142,145 @@ export const replaceCbt = (endpoint, ids) => {
 /**
  *
  * @param {string} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
- *   + The version parameter can be omitted by using `<version>/<endpoint>`
+ *   + The version parameter is forced to apply `latest`
  */
 export const curl = (endp) => {
     endp = endp.replace(/^\/+|\/+$/g, "");
     return `${BASE}/latest/${endp}/`;
 };
+/**
+ * @date 2020/03/31
+ * @version 2.1
+ * @type {() => Promise<string>}
+ */
+export async function getSDEVersion() {
+    const sdeZipUrl = "https://eve-static-data-export.s3-eu-west-1.amazonaws.com/tranquility/sde.zip";
+    try {
+        const res = await fetch(sdeZipUrl, { method: "head", mode: "cors" });
+        const date = res.headers.get("last-modified");
+        if (date) {
+            const YMD = new Date(date).toLocaleDateString('en-CA').replace(/-/g, '');
+            return `sde-${YMD}-TRANQUILITY`;
+        }
+        else {
+            console.error("Failed to retrieve 'last-modified' header.");
+            return "sde-202Xxxxx-TRANQUILITY";
+        }
+    }
+    catch (e) {
+        console.error("Error fetching SDE version:", e);
+        return "sde-202Xxxxx-TRANQUILITY";
+    }
+}
+export function getLogger() {
+    const clog = console.log.bind(console, '- - -> Get the character data of "CCP Zoetrope"'.magenta);
+    const rlog = console.log.bind(console, '- - -> Run ESI request'.cyan);
+    return { clog, rlog };
+}
+/**
+ * Need typescript v5.5 later
+ * @import * as ESI from "./v2";
+ * @typedef {ESI.TESIResponseOKMap} TESIResponseOKMap
+ * @typedef {ESI.IESIRequestFunction<ESIRequestOptions>} IESIRequestFunction
+ * @typedef {ESI.TESIRequestFunctionMethods<ESIRequestOptions>} TESIRequestFunctionMethods
+ */
+/**
+ * #### Fire a request that does not require authentication.
+ *
+ * @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
+ *
+ * @param {TESIRequestFunctionSignature<ESIRequestOptions> | TESIRequestFunctionMethods} fn
+ * @param {M} method
+ * @param {EP} endpoint
+ * @param {P2} [pathParams]
+ * @param {Opt} [opt]
+ * @returns {Promise<R>}
+ */
+function fireWithoutAuth(fn, method, endpoint, pathParams, opt) {
+    if (typeof fn === "function") {
+        return fn(method, endpoint, pathParams, opt);
+    }
+    return fn[method](endpoint, pathParams, opt);
+}
+// It should complete correctly.
+/**
+ * #### Fire a request that does not require authentication.
+ *
+ * @param {TESIRequestFunctionSignature<ESIRequestOptions> | TESIRequestFunctionMethods} fn
+ */
+export async function fireRequestsDoesNotRequireAuth(fn) {
+    const { clog, rlog } = getLogger();
+    try {
+        // - - - - - - - - - - - -
+        //       Character
+        // - - - - - - - - - - - -
+        // Here, I borrow data from "CCP Zoetrope".
+        clog();
+        await fireWithoutAuth(fn, "get", "/characters/{character_id}/", 2112625428).then(log);
+        clog('(portrait)');
+        await fireWithoutAuth(fn, "get", "/characters/{character_id}/portrait/", 2112625428).then(log);
+        clog('(affiliation)');
+        const affiliation = await fireWithoutAuth(fn, "post", "/characters/affiliation/", { body: [2112625428] });
+        log(affiliation);
+        clog('(corporation)');
+        await fireWithoutAuth(fn, "get", "/corporations/{corporation_id}/", affiliation[0].corporation_id).then(log);
+        rlog("get:/incursions/".green);
+        await fireWithoutAuth(fn, "get", "/incursions/").then(log);
+        // - - - - - - - - - - - -
+        //     Miscellaneous
+        // - - - - - - - - - - - -
+        rlog("post:/universe/ids/".green);
+        const ids = await fireWithoutAuth(fn, "post", "/universe/ids/", { body: ["the forge", "plex"] });
+        log(ids.inventory_types, ids.regions);
+        rlog(`get:/markets/${ids?.regions?.[0].id}/orders/?type_id=${ids?.inventory_types?.[0].id}, item PLEX`.green);
+        const orders = await fireWithoutAuth(fn, "get", "/markets/{region_id}/orders/", ids?.regions?.[0].id, {
+            query: {
+                // page: 1,
+                order_type: "sell",
+                type_id: ids?.inventory_types?.[0].id
+            }
+        });
+        log(orders.sort((a, b) => a.price - b.price).slice(0, 2));
+        rlog("get:/universe/structures/?filter=market".green);
+        // query patameter `filter` is optional
+        const structures = await fireWithoutAuth(fn, "get", "/universe/structures/", {
+            query: {
+                filter: "market"
+            }
+        });
+        log(`/universe/structures/[0]=${structures[0]}, length=${structures.length}`);
+        // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
+        //  The following is code to observe the behavior of completion by generics.
+        //  Authentication is required, so an error will occur.
+        // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 
+        let ok = await fireWithoutAuth(fn, "get", "/characters/{character_id}/ship/", 994562, {
+            auth: true,
+            ignoreError: true,
+            token: "token.token.token"
+        });
+        // in this case, "categories" and "search" is required
+        await fireWithoutAuth(fn, "get", "/characters/{character_id}/search/", 994562, {
+            query: {
+                categories: ["agent"],
+                search: "ok"
+            },
+            auth: true
+        });
+        // in this case, "order_type" is required
+        await fireWithoutAuth(fn, "get", "/markets/{region_id}/orders/", 994562, {
+            query: {
+                order_type: "all"
+            },
+        });
+        // TODO: want TypeScript semantics to throw an error because there is a required query parameter, but it's not possible
+        await fireWithoutAuth(fn, "get", "/characters/{character_id}/search/");
+        log(ok);
+    }
+    catch (e) {
+        console.error("Failed to request -", e);
+    }
+}

package/tsconfig.json

@@ -4,6 +4,7 @@
     "skipDefaultLibCheck": true,
     "skipLibCheck": true,
     "declaration": true,
+    // "declarationDir": "./dts",
     "outDir": ".", 
     "target": "esnext",
     "module": "esnext",
@@ -13,11 +14,13 @@
     "strict": true,
     "moduleResolution": "node",
     "rootDirs": [
-      "./"
+      "./scripts"
     ]
   },
   "include": [
-    "./*.mts"
+    "./scripts/*.mts"
   ],
-  "exclude": []
+  "exclude": [
+    "./scripts/auth-*"
+  ]
 }