eve-esi-types 2.2.6 → 2.3.2

package/lib/tagged-request-api.mjs

@@ -0,0 +1,74 @@
+/*!
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+//  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
+//  Released under the MIT license
+//  https://opensource.org/licenses/mit-license.php
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/// <reference types="../v2/esi-tagged-types"/>
+/**
+ * @file eve-esi-types/lib/tagged-request-api.mts
+ */
+import { request } from "./request-api.mjs";
+/**
+ * @typedef {`${string}${"" | `,${string}`}`} TMethodList
+ */
+/** @satisfies {`${XESI.ESITags}:${TMethodList}`[]} */
+const ESITagsWithMethodList = [
+    "Alliance:get", "Assets:get,post",
+    "Calendar:get,put", "Character:get,post",
+    "Clones:get", "Contacts:get,post,put,delete",
+    "Contracts:get", "Corporation:get",
+    "Dogma:get", "Faction Warfare:get",
+    "Fittings:get,post,delete", "Fleets:get,post,put,delete",
+    "Incursions:get", "Industry:get",
+    "Insurance:get", "Killmails:get",
+    "Location:get", "Loyalty:get",
+    "Mail:get,post,put,delete", "Market:get",
+    "Opportunities:get", "Planetary Interaction:get",
+    "Routes:get", "Search:get",
+    "Skills:get", "Sovereignty:get",
+    "Status:get", "Universe:get,post",
+    "User Interface:post", "Wallet:get",
+    "Wars:get"
+];
+/**
+ * `esi-tagged-types` and `injectESIRequestBody` allow for more intuitive use of ESI requests based on the "tags" defined in the EVE Swagger JSON.
+ *
+ * + The `ESI request API object` constructed by `injectESIRequestBody` lists narrowed endpoints by accessing the camel-cased "tags" members.
+ *
+ * @example
+ *    import * as taggedApi from "eve-esi-types/lib/tagged-request-api.mjs";
+ *
+ *    const esiRequest = taggedApi.injectESIRequestBody(...);
+ *    const ret = await esiRequest.universe.get("/universe/structures/", { query: { filter: "market" }});
+ *
+ * @template {Record<string, unknown>} Opt
+ * @param {TESIRequestFunctionSignature<{}>} requestBody
+ * @returns {XESI.TaggedESIRequestMap}
+ * @since 2.3
+ */
+export function injectESIRequestBody(requestBody) {
+    const rq = /** @type {XESI.TaggedESIRequestMap<Opt>} */ ({});
+    for (const tagEntry of ESITagsWithMethodList) {
+        const [tag, methodList] = /** @type {[tag: XESI.ESITags, methods: TMethodList]} */ (tagEntry.split(":"));
+        const methods = /** @type {TESIEntryMethod[]} */ (methodList.split(","));
+        const entry = /** @type {XESI.ESITaggedEndpointRequest<typeof tag, Opt>} */ ({});
+        for (const method of methods) {
+            // @ts-expect-error
+            entry[method] = /** @satisfies {XESI.TaggedEndpointRequestFunction<typeof method, typeof tag>} */ ((e, params, opt) => requestBody(method, e, params, opt));
+        }
+        const camelCased = /** @type {XESI.LCamelCase<XESI.ESITags>} */ (tag[0].toLowerCase() + tag.slice(1).replace(/\s(.)/g, "$1"));
+        rq[camelCased] = entry;
+    }
+    return rq;
+}
+/**
+ * @import { ESIRequestOptions } from "./rq-util.mjs";
+ */
+/**
+ * Injects the minimal implementation of ESI requests into `XESI.TaggedESIRequestMap`.
+ * @since 2.3
+ * @type {XESI.TaggedESIRequestMap<ESIRequestOptions>}
+ */
+export const esi = injectESIRequestBody(request);

package/minimal-rq.d.mts

@@ -1,29 +1 @@
-/*!
-// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-//  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>;
+export {};

package/minimal-rq.mjs

@@ -9,74 +9,28 @@
 // - - - - - - - - - - - - - - - - - - - -
 //               imports
 // - - - - - - - - - - - - - - - - - - - -
-import * as util from "./rq-util.mjs";
+import * as util from "./lib/rq-util.mjs";
+import { request } from "./lib/request-api.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
+/** @type {TESIEntryMethod[]} */ (["get", "post", "put", "delete"]).forEach((method) => {
+    esiMethods[method] = /** @type {TESIRequestFunctionEachMethod<typeof method>} */ (function (endpoint, params, opt) {
         return request(method, endpoint, params, opt);
-    };
+    });
 });
 // It should complete correctly.
 /**
@@ -126,7 +80,9 @@ async function getEVEStatus(fn) {
 }
 // type following and run
 // node minimal-rq.mjs -debug
-getEVEStatus(request).then(eveStatus => log(eveStatus));
+if (!util.is("x")) {
+    getEVEStatus(request).then(eveStatus => log(eveStatus));
+}
 // {
 //     "players": 16503,
 //     "server_version": "2794925",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "2.2.6",
+  "version": "2.3.2",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
   "main": "v2/index.d.ts",
   "scripts": {
@@ -13,6 +13,7 @@
   },
   "files": [
     "v2",
+    "lib",
     "*.d.mts",
     "*.mjs",
     "LICENSE",
@@ -36,6 +37,7 @@
   },
   "homepage": "https://github.com/jeffy-g/eve-esi-types#readme",
   "devDependencies": {
-    "colors.ts": "^1.0.20"
+    "colors.ts": "^1.0.20",
+    "typescript": "latest"
   }
 }

package/tagged-rq.d.mts

@@ -0,0 +1 @@
+export {};

package/tagged-rq.mjs

@@ -0,0 +1,23 @@
+/*!
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+//  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
+//  Released under the MIT license
+//  https://opensource.org/licenses/mit-license.php
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/**
+ * @file tagged-rq.mts
+ * @command node tagged-rq.mjs -x
+ */
+import { esi as esiRq } from "./lib/tagged-request-api.mjs";
+// console.log(esiRq);
+// Furthermore, the endpoint selected is narrowed down by "tags" and "method".
+esiRq.character.get("/characters/{character_id}/", 2112625428).then(console.log);
+esiRq.universe.get("/universe/structures/", { query: { filter: "market" } }).then(console.log);
+esiRq.universe.post("/universe/ids/", {
+    body: ["the forge", "plex"]
+}).then(console.log);
+esiRq.fittings.delete("/characters/{character_id}/fittings/{fitting_id}/", [1234, 56789]);
+esiRq.assets.get("/characters/{character_id}/assets/", 1234, {
+    auth: true
+}).then(console.log).catch(console.log);

package/tsconfig.json

@@ -8,7 +8,6 @@
     "outDir": ".", 
     "target": "esnext",
     "module": "esnext",
-    // "declaration": true,
     "diagnostics": true,
     "newLine": "LF",
     "strict": true,
@@ -18,7 +17,9 @@
     ]
   },
   "include": [
-    "./scripts/*.mts"
+    "./scripts/**/*.mts",
+    "./scripts/**/*.d.ts",
+    "./v2/*.d.ts"
   ],
   "exclude": [
     "./scripts/auth-*",

package/v2/esi-tagged-types.d.ts

@@ -0,0 +1,153 @@
+/*!
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+//  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
+//  Released under the MIT license
+//  https://opensource.org/licenses/mit-license.php
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+*/
+/**
+ * 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 2.3.2 of the EVE Online ESI response types.
+ */
+import { TESIResponseOKMap } from "./index.d.ts";
+export * from "./index.d.ts";
+
+/**
+ * Converts a string to lower camel case.
+ * 
+ * @template S - The string to convert.
+ * @example
+ * // returns "assets"
+ * LCamelCase<"Assets">
+ * @example
+ * // returns "factionWarfare"
+ * LCamelCase<"Faction Warfare">
+ * @date 2025/2/27
+ */
+export declare type LCamelCase<S extends string> = S extends `${infer P1} ${infer P2}`
+  ? `${Lowercase<P1>}${Capitalize<P2>}` : Lowercase<S>;
+
+
+declare const enum EInferSomethingBy {
+  METHOD,
+  TAGs
+}
+declare type InferSomethingBy<Tag, AsType extends EInferSomethingBy = EInferSomethingBy.METHOD> = {
+  [M in TESIEntryMethod]: TESIResponseOKMap[M] extends Record<`/${string}/`, { tag: infer ActualTag }>
+    ? AsType extends EInferSomethingBy.TAGs
+      ? ActualTag : ActualTag extends Tag
+        ? M
+      : never
+    : never;
+}[TESIEntryMethod];
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+//               Utility Type `ESITags`
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+/**
+ * Maps HTTP methods to their corresponding tags.
+ * @template M - The HTTP method.
+ * @date 2025/2/28
+ */
+export declare type ESITags = InferSomethingBy<never, EInferSomethingBy.TAGs>
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+//            Utility Type `InferMethod`
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+/**
+ * Infers the HTTP method based on the provided tag.
+ * 
+ * @template Tag - The tag to infer the method for.
+ * @date 2025/2/28
+ */
+export declare type InferMethod<Tag> = InferSomethingBy<Tag>
+// type XAssets = InferMethod<"Assets">;
+// type XContacts = InferMethod<"Contacts">;
+// type XPlanetary = InferMethod<"Planetary Interaction">;
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+//    Utility Type `TaggedEndpointRequestFunction`
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+/**
+ * Creates a function type for making requests to tagged endpoints.
+ * 
+ * @template M - The HTTP method.
+ * @template Tag - The tag associated with the endpoint.
+ * @template ActualOpt - The actual options for the request.
+ * @template EP - The endpoint path.
+ * @template P2 - The path parameters.
+ * @template Opt - The request options.
+ * @template R - The response type.
+ * 
+ * @param endpoint - The endpoint path.
+ * @param pathParams - The path parameters.
+ * @param options - The request options.
+ * @returns A promise that resolves to the response.
+ * @date 2025/2/28
+ */
+export declare type TaggedEndpointRequestFunction<M extends TESIEntryMethod, Tag extends ESITags, ActualOpt = {}> = <
+  EP extends SelectEndpointByTag<Tag, 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>;
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+//    Utility Type `ESITaggedEndpointRequest`
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+/**
+ * Maps tags to their corresponding endpoint request functions.
+ * 
+ * @template Tag - The tag to map.
+ * @date 2025/2/28
+ */
+export declare type ESITaggedEndpointRequest<Tag extends ESITags, ActualOpt = {}> = {
+  [tag in Tag]: {
+    [method in InferMethod<Tag>]: TaggedEndpointRequestFunction<method, tag, ActualOpt>;
+  };
+}[Tag];
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+//        Utility Type `SelectEndpointByTag`
+// - - - - - - - - - - - - - - - - - - - - - - - - - -
+/**
+ * Selects an endpoint by tag and method.
+ * 
+ * @template Tag - The tag associated with the endpoint.
+ * @template M - The HTTP method.
+ * @template EP - The endpoint path.
+ * @date 2025/2/28
+ */
+export declare type SelectEndpointByTag<
+  Tag extends ESITags, M extends TESIEntryMethod
+> = {
+  [EP in keyof TESIResponseOKMap[M]]: TESIResponseOKMap[M][EP] extends { tag: infer ActualTag }
+    ? ActualTag extends Tag
+      ? EP : never
+    : never;
+}[keyof TESIResponseOKMap[M]];
+// type XAssetsEndpointGet = SelectEndpointByTag<"Assets", "get">;
+// type XAssetsEndpointPost = SelectEndpointByTag<"Assets", "post">;
+
+/**
+ * Maps lower camel case tags to their corresponding endpoint request functions.
+ * @date 2025/2/28
+ */
+export declare type TaggedESIRequestMap<ActualOpt = {}> = {
+  [tag in ESITags as LCamelCase<tag>]: ESITaggedEndpointRequest<tag, ActualOpt>;
+};
+
+/**
+ * Creates a partial map of lower camel case tags to their corresponding endpoint request functions.
+ * ```ts
+ * // implements "factionWarfare", "wallet"
+ * const esiRq: XTaggedESIRequestMapPartial<"factionWarfare" | "wallet">;
+ * ```
+ * 
+ * @template Props - The properties to require in the partial map.
+ * @date 2025/2/28
+ */
+export declare type TaggedESIRequestMapPartial<Props extends LCamelCase<ESITags>> = RequireThese<Partial<TaggedESIRequestMap>, Props>;
+
+export as namespace XESI;

package/v2/get_characters_character_id_skillqueue_ok.d.ts

@@ -4,7 +4,7 @@
 /**
  * 200 ok array
  *
- * @maxItems 150
+ * @maxItems 200
  */
 type GetCharactersCharacterIdSkillqueueOk = GetCharactersCharacterIdSkillqueue_200Ok[];
 

package/v2/index.d.ts

@@ -6,19 +6,16 @@
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
 /**
- * THIS TSD IS AUTO GENERATED, DO NOT EDIT
+ * 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 2.2.6 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 2.3.2 of the EVE Online ESI response types.
  */
 
 import type { TESIResponseOKMap } from "./response-map.d.ts";
 export type { TESIResponseOKMap } from "./response-map.d.ts";
 
-/**
- * mark a specific property as `required`
- */
-type RequireThese<T, K extends keyof T> = T & Required<Pick<T, K>>;
+import type { PickPathParameters, InferKeysLen } from "./util.d.ts";
 
 /**
  * Represents a function that can make ESI requests with various HTTP methods.
@@ -73,6 +70,25 @@ export type TESIRequestFunctionMethods<ActualOpt = {}> = {
 
 declare global {
 
+  /**
+   * mark a specific property as `required`
+   */
+  type RequireThese<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+  /**
+   * If `EP` (endpoint) is a parameterized path, determines the required number of replacements.
+   * 
+   * @template EP The string representing the endpoint path.
+   * @template Opt The type to return if `EP` is not parameterized.
+   * @returns {number | [number, number] | Opt} 
+   * Returns `number` if there is one parameter, `[number, number]` if there are two parameters, otherwise `Opt`.
+   */
+  type IfParameterizedPath<EP, Opt> = EP extends `${string}/{${string}}${string}`
+    ? PickPathParameters<EP> extends never
+      ? Opt : InferKeysLen<PickPathParameters<EP>> extends 1
+          ? number : [number, number]
+      : Opt;
+
   /**
    * ### ESI request function all in one signature
    * 
@@ -117,15 +133,6 @@ declare global {
     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.
    *
@@ -136,7 +143,7 @@ declare global {
   //* ctt
   type IdentifyParameters<
     Entry, Opt,
-    Keys = Exclude<keyof Entry, "result">
+    Keys = Exclude<keyof Entry, "result" | "tag">
   > = RequireThese<Opt, Keys> & Pick<Entry, Keys>;
   /*/
   type IdentifyParameters<
@@ -158,9 +165,8 @@ declare global {
 
   /**
    * Represents a response with no content (HTTP status 204).
-   * Although no data is returned, it indicates successful completion by returning a status of 204.
    */
-  type NoContentResponse = { status: 204 };
+  type NoContentResponse = { /* status: 204 */ };
 
   /**
    * Represents the HTTP methods supported by ESI.