eve-esi-types 3.1.0 → 3.1.2

package/README.md

@@ -100,4 +100,6 @@ const ret = await esiRequest.universe.get("/universe/structures/", { query: { fi
 
 ## References
 
-- [`ESI Types Utility Definitions`](./esi-types-util3.md)
+- [`ESI Types Utility Definitions`](./docs/esi-types-util3.md)
+
+- [`ESI Tagged Types Utility Definitions`](./docs/esi-tagged-types.md)

package/docs/esi-tagged-types.md

@@ -0,0 +1,120 @@
+# ESI Tagged Types
+
+This document provides an overview of the types defined in the `eve-esi-types/v2/esi-tagged-types.d.ts` file. These types are used to handle EVE Online ESI responses.
+
+## LCamelCase
+
+Converts a string to lower camel case.
+
+```typescript
+type LCamelCase<S extends string> = S extends `${infer P1} ${infer P2}`
+  ? `${Lowercase<P1>}${Capitalize<P2>}` : Lowercase<S>;
+```
+
+### Example
+
+```typescript
+// returns "assets"
+LCamelCase<"Assets">
+
+// returns "factionWarfare"
+LCamelCase<"Faction Warfare">
+```
+
+## InferSomethingBy
+
+Infers something by a brand.
+
+```typescript
+type InferSomethingByBrand<N = number> = N & { __enum: "InferSomethingBy" };
+type InferSomethingByMethod  = InferSomethingByBrand<0>;
+type InferSomethingByTags    = InferSomethingByBrand<1>;
+type InferSomethingBy<Tag, AsType extends InferSomethingByBrand = InferSomethingByMethod> = {
+  [M in TESIEntryMethod]: TESIResponseOKMap[M] extends Record<`/${string}/`, { tag: infer ActualTag }>
+    ? AsType extends InferSomethingByTags
+      ? ActualTag : ActualTag extends Tag
+        ? M
+      : never
+    : never;
+}[TESIEntryMethod];
+```
+
+## ESITags
+
+Maps HTTP methods to their corresponding tags.
+
+```typescript
+type ESITags = InferSomethingBy<never, InferSomethingByTags>;
+```
+
+## InferMethod
+
+Infers the HTTP method based on the provided tag.
+
+```typescript
+type InferMethod<Tag> = InferSomethingBy<Tag>;
+```
+
+## TaggedEndpointRequestFunction2
+
+Creates a function type for making requests to tagged endpoints.
+
+```typescript
+type TaggedEndpointRequestFunction2<
+  M extends TESIEntryMethod, Tag extends ESITags,
+  ActualOpt extends Record<string, unknown> = {},
+  EndPoints extends SelectEndpointByTag<Tag, M> = SelectEndpointByTag<Tag, M>,
+> = <
+    REP extends ReplacePathParams<EndPoints> | EndPoints,
+    EPX extends _InferEndpointOrigin<REP, EndPoints> extends never ? REP: _InferEndpointOrigin<REP, EndPoints>,
+    PPM extends InferPathParams<REP, EPX>,
+    Opt extends IdentifyParameters<M, EPX, ActualOpt & PPM>,
+    Ret extends InferESIResponseResult<M, EPX>,
+    HasOpt = HasRequireParams<M, EPX, PPM>,
+>(endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
+```
+
+## ESITaggedEndpointRequest2
+
+Maps tags to their corresponding endpoint request functions.
+
+```typescript
+type ESITaggedEndpointRequest2<Tag extends ESITags, ActualOpt extends Record<string, unknown> = {}> = {
+  [tag in Tag]: {
+    [method in InferMethod<Tag>]: TaggedEndpointRequestFunction2<method, tag, ActualOpt>;
+  };
+}[Tag];
+```
+
+## SelectEndpointByTag
+
+Selects an endpoint by tag and method.
+
+```typescript
+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]];
+```
+
+## TaggedESIRequestMap2
+
+Maps lower camel case tags to their corresponding endpoint request functions.
+
+```typescript
+type TaggedESIRequestMap2<ActualOpt extends Record<string, unknown> = {}> = {
+  [tag in ESITags as LCamelCase<tag>]: ESITaggedEndpointRequest2<tag, ActualOpt>;
+};
+```
+
+## TaggedESIRequestMapPartial2
+
+Creates a partial map of lower camel case tags to their corresponding endpoint request functions.
+
+```typescript
+type TaggedESIRequestMapPartial2<Props extends LCamelCase<ESITags>> = RequireThese<Partial<TaggedESIRequestMap2>, Props>;
+```

package/{esi-types-util3.md → docs/esi-types-util3.md}

@@ -8,7 +8,7 @@
 
 # ESI Types Utility 3.1 Summary
 
-This document provides detailed explanations of each type defined in the `index.d.ts` file.
+This document provides detailed explanations of each type defined in the `eve-esi-types/v2/index.d.ts` file.
 
 > ## TESIRequestFunctionSignature2
 

package/lib/rq-util.d.mts

@@ -181,9 +181,9 @@ export declare function getLogger(): {
     clog: (...args: any[]) => void;
     rlog: (...args: any[]) => void;
 };
-export type TFireWithoutAuth = <M extends TESIEntryMethod, RealEP extends ReplacePathParams<ESIEndpointOf<M>> | ESIEndpointOf<M>, EPx extends ResolvedEndpoint<RealEP, M>, PathParams extends InferPathParams<RealEP, EPx>, Opt extends IdentifyParameters<M, EPx, ESIRequestOptions & PathParams>, R extends InferESIResponseResult<M, EPx>, HasOpt = HasRequireParams<M, EPx, PathParams>, XX = PickRequireParams<M, EPx, PathParams>>(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>, method: M, endpoint: RealEP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<R>;
-export interface IFireWithoutAuth {
-    <M extends TESIEntryMethod, RealEP extends ReplacePathParams<ESIEndpointOf<M>> | ESIEndpointOf<M>, EPx extends ResolvedEndpoint<RealEP, M>, PathParams extends InferPathParams<RealEP, EPx>, Opt extends IdentifyParameters<M, EPx, ESIRequestOptions & PathParams>, R extends InferESIResponseResult<M, EPx>, HasOpt = HasRequireParams<M, EPx, PathParams>, XX = PickRequireParams<M, EPx, PathParams>>(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>, method: M, endpoint: RealEP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]): Promise<R>;
+export type TFireWithoutAuth<ActualOpt = ESIRequestOptions> = <Mtd extends TESIEntryMethod, REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>, EPX extends ResolvedEndpoint<REP, Mtd>, PPM extends InferPathParams<REP, EPX>, Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>, Ret extends InferESIResponseResult<Mtd, EPX>, HasOpt = HasRequireParams<Mtd, EPX, PPM>, XX = PickRequireParams<Mtd, EPX, PPM>>(fn: TESIRequestFunctionSignature2<ESIRequestOptions> | TESIRequestFunctionMethods2<ESIRequestOptions>, method: Mtd, endpoint: REP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
+export interface IFireWithoutAuth<ActualOpt = ESIRequestOptions> {
+    <Mtd extends TESIEntryMethod, REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>, EPX extends ResolvedEndpoint<REP, Mtd>, PPM extends InferPathParams<REP, EPX>, Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>, Ret extends InferESIResponseResult<Mtd, EPX>, HasOpt = HasRequireParams<Mtd, EPX, PPM>, XX = PickRequireParams<Mtd, EPX, PPM>>(fn: TESIRequestFunctionSignature2<ActualOpt> | TESIRequestFunctionMethods2<ActualOpt>, method: Mtd, endpoint: REP, ...opt: HasOpt extends 1 ? [Opt] : [Opt?]): Promise<Ret>;
 }
 /**
  * Need typescript v5.5 later

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
   "main": "v2/index.d.ts",
   "scripts": {
@@ -15,6 +15,7 @@
     "v2",
     "lib",
     "web",
+    "docs",
     "*.d.mts",
     "*.mjs",
     "LICENSE",

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

@@ -9,7 +9,7 @@
  * 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 3.1.0 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.1 of the EVE Online ESI response types.
  */
 import { TESIResponseOKMap } from "./index.d.ts";
 export * from "./index.d.ts";
@@ -61,26 +61,51 @@ export declare type ESITags = InferSomethingBy<never, InferSomethingByTags>
  * @date 2025/2/28
  */
 export declare type InferMethod<Tag> = InferSomethingBy<Tag>
-// type XAssets = InferMethod<"Assets">;
-// type XContacts = InferMethod<"Contacts">;
-// type XPlanetary = InferMethod<"Planetary Interaction">;
+/* ctt
+type XAssets = InferMethod<"Assets">;
+type XContacts = InferMethod<"Contacts">;
+type XPlanetary = InferMethod<"Planetary Interaction">;
+/*/
+//*/
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
 //    Utility Type `TaggedEndpointRequestFunction2`
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
+/**
+ * Infers the endpoint origin based on the provided endpoints.
+ * 
+ *  + Customed InferEndpointOrigin
+ * 
+ * @template RealEP - The real endpoint type.
+ * @template Endpoints - The possible endpoints.
+ * 
+ * @typeParam RealEP - The type of the real endpoint.
+ * @typeParam Endpoints - The type of the possible endpoints.
+ * 
+ * @returns The inferred endpoint origin.
+ */
+type _InferEndpointOrigin<
+  RealEP extends unknown, Endpoints extends string | number | symbol
+> = {
+  [EP in Endpoints]: RealEP extends ReplacePathParams<EP>
+    ? EP : never;
+}[Endpoints];
+
 /**
  * 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 EndPoints - The possible endpoints.
+ * @template REP - The real endpoint path.
+ * @template EPX - The inferred endpoint origin.
+ * @template PPM - The path parameters.
  * @template Opt - The request options.
- * @template R - The response type.
+ * @template Ret - The response type.
+ * @template HasOpt - Indicates if the endpoint has required parameters.
  * 
  * @param endpoint - The endpoint path.
- * @param pathParams - The path parameters.
  * @param options - An optional object containing additional options for the request. If the endpoint has required parameters, this parameter must be provided.
  * @returns A promise that resolves to the response.
  * 
@@ -88,17 +113,18 @@ export declare type InferMethod<Tag> = InferSomethingBy<Tag>
  * The `...options: HasOpt extends 1 ? [Opt] : [Opt?]` parameter is defined this way to enforce that if the endpoint has required parameters,  
  * the `options` parameter must be provided. If there are no required parameters, the `options` parameter is optional.
  */
-// TODO: 2025/3/16 1:20:50 Generics bug maybe OK?
-export declare type TaggedEndpointRequestFunction2<M extends TESIEntryMethod, Tag extends ESITags, ActualOpt = {}> = <
-    RealEP extends ReplacePathParams<ESIEndpointOf<M>> | ESIEndpointOf<M>,
-    EPx extends ResolvedEndpoint<RealEP, M>,
-    PathParams extends InferPathParams<RealEP, EPx>,
-    Opt extends IdentifyParameters<M, EPx, ActualOpt & PathParams>,
-    R extends InferESIResponseResult<M, EPx>,
-    HasOpt = HasRequireParams<M, EPx, PathParams>,
-  // RealEPX = ReplacePathParamsX<RealEPX>,
-  // EPX = ReplacePathParams<EP>,
->(endpoint: RealEP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<R>;
+export declare type TaggedEndpointRequestFunction2<
+  M extends TESIEntryMethod, Tag extends ESITags,
+  ActualOpt extends Record<string, unknown> = {},
+  EndPoints extends SelectEndpointByTag<Tag, M> = SelectEndpointByTag<Tag, M>,
+> = <
+    REP extends ReplacePathParams<EndPoints> | EndPoints,
+    EPX extends _InferEndpointOrigin<REP, EndPoints> extends never ? REP: _InferEndpointOrigin<REP, EndPoints>,
+    PPM extends InferPathParams<REP, EPX>,
+    Opt extends IdentifyParameters<M, EPX, ActualOpt & PPM>,
+    Ret extends InferESIResponseResult<M, EPX>,
+    HasOpt = HasRequireParams<M, EPX, PPM>,
+>(endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
 
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -108,9 +134,10 @@ export declare type TaggedEndpointRequestFunction2<M extends TESIEntryMethod, Ta
  * Maps tags to their corresponding endpoint request functions.
  * 
  * @template Tag - The tag to map.
+ * @template ActualOpt - The actual options for the request.
  * @date 2025/2/28
  */
-export declare type ESITaggedEndpointRequest2<Tag extends ESITags, ActualOpt = {}> = {
+export declare type ESITaggedEndpointRequest2<Tag extends ESITags, ActualOpt extends Record<string, unknown> = {}> = {
   [tag in Tag]: {
     [method in InferMethod<Tag>]: TaggedEndpointRequestFunction2<method, tag, ActualOpt>;
   };
@@ -135,14 +162,19 @@ export declare type SelectEndpointByTag<
       ? EP : never
     : never;
 }[keyof TESIResponseOKMap[M]];
-// type XAssetsEndpointGet = SelectEndpointByTag<"Assets", "get">;
-// type XAssetsEndpointPost = SelectEndpointByTag<"Assets", "post">;
+/* ctt
+type XAssetsEndpointGet = SelectEndpointByTag<"Assets", "get">;
+type XAssetsEndpointPost = SelectEndpointByTag<"Assets", "post">;
+/*/
+//*/
 
 /**
  * Maps lower camel case tags to their corresponding endpoint request functions.
+ * 
+ * @template ActualOpt - The actual options for the request.
  * @date 2025/3/12
  */
-export declare type TaggedESIRequestMap2<ActualOpt = {}> = {
+export declare type TaggedESIRequestMap2<ActualOpt extends Record<string, unknown> = {}> = {
   [tag in ESITags as LCamelCase<tag>]: ESITaggedEndpointRequest2<tag, ActualOpt>;
 };
 

package/v2/index.d.ts

@@ -9,7 +9,7 @@
  * 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 3.1.0 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.1 of the EVE Online ESI response types.
  */
 import type { TESIResponseOKMap } from "./response-map.d.ts";
 export type { TESIResponseOKMap } from "./response-map.d.ts";
@@ -195,12 +195,12 @@ declare global {
    * This function sends a request to a specified endpoint and returns a response.
    * 
    * @template ActualOpt - The actual type of the option.
-   * @template M - The HTTP method to use for the request
-   * @template RealEP - The real path of the ESI endpoint to send the request to
-   * @template EP - The parameterized path of the ESI endpoint to send the request to
-   * @template PathParams - Parameters to include in the request if the endpoint is parameterized
+   * @template Mtd - The HTTP method to use for the request
+   * @template REP - The real path of the ESI endpoint to send the request to
+   * @template EPX - The parameterized path of the ESI endpoint to send the request to
+   * @template PPM - Parameters to include in the request if the endpoint is parameterized
    * @template Opt - Options to include in the request. If there is a required parameter, its type will be merged with `ActualOpt`
-   * @template R - The response type
+   * @template Ret - The response type
    * 
    * @param method - The HTTP method to use for the request (e.g., "get", "post").
    * @param endpoint - The real path of the ESI endpoint to send the request to.
@@ -213,28 +213,28 @@ declare global {
    * the `options` parameter must be provided. If there are no required parameters, the `options` parameter is optional.
    */
   type TESIRequestFunctionSignature2<ActualOpt> = <
-    M extends TESIEntryMethod,
-    RealEP extends ReplacePathParams<ESIEndpointOf<M>> | ESIEndpointOf<M>,
-    EPx extends ResolvedEndpoint<RealEP, M>,
-    PathParams extends InferPathParams<RealEP, EPx>,
-    Opt extends IdentifyParameters<M, EPx, ActualOpt & PathParams>,
-    R extends InferESIResponseResult<M, EPx>,
-    HasOpt = HasRequireParams<M, EPx, PathParams>,
-  >(method: M, endpoint: RealEP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<R>;
+    Mtd extends TESIEntryMethod,
+    REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>,
+    EPX extends ResolvedEndpoint<REP, Mtd>,
+    PPM extends InferPathParams<REP, EPX>,
+    Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>,
+    Ret extends InferESIResponseResult<Mtd, EPX>,
+    HasOpt = HasRequireParams<Mtd, EPX, PPM>,
+  >(method: Mtd, endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
 
   /**
    * Represents a function that can make ESI requests for a specific HTTP method.
    *
    * This type is used to define functions that send requests to specific ESI endpoints using a given HTTP method.
    *
-   * @template M - The HTTP method to use for the request.
+   * @template Mtd - The HTTP method to use for the request.
    * @template ActualOpt - The actual type of the options.
    *
-   * @template RealEP - The real path of the ESI endpoint to send the request to.
-   * @template EP - The parameterized path of the ESI endpoint to send the request to.
-   * @template PathParams - Parameters to include in the request if the endpoint is parameterized.
+   * @template REP - The real path of the ESI endpoint to send the request to.
+   * @template EPX - The parameterized path of the ESI endpoint to send the request to.
+   * @template PPM - Parameters to include in the request if the endpoint is parameterized.
    * @template Opt - Options to include in the request. If there is a required parameter, its type will be merged with `ActualOpt`.
-   * @template R - The response type.
+   * @template Ret - The response type.
    *
    * @param endpoint - The real path of the ESI endpoint to send the request to.
    * @param options - An optional object containing additional options for the request. If the endpoint has required parameters, this parameter must be provided.
@@ -245,14 +245,14 @@ declare global {
    * The `...options: HasOpt extends 1 ? [Opt] : [Opt?]` parameter is defined this way to enforce that if the endpoint has required parameters,  
    * the `options` parameter must be provided. If there are no required parameters, the `options` parameter is optional.
    */
-  type TESIRequestFunctionEachMethod2<M extends TESIEntryMethod, ActualOpt = {}> = <
-    RealEP extends ReplacePathParams<ESIEndpointOf<M>> | ESIEndpointOf<M>,
-    EPx extends ResolvedEndpoint<RealEP, M>,
-    PathParams extends InferPathParams<RealEP, EPx>,
-    Opt extends IdentifyParameters<M, EPx, ActualOpt & PathParams>,
-    R extends InferESIResponseResult<M, EPx>,
-    HasOpt = HasRequireParams<M, EPx, PathParams>,
-  >(endpoint: RealEP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<R>;
+  type TESIRequestFunctionEachMethod2<Mtd extends TESIEntryMethod, ActualOpt = {}> = <
+    REP extends ReplacePathParams<ESIEndpointOf<Mtd>> | ESIEndpointOf<Mtd>,
+    EPX extends ResolvedEndpoint<REP, Mtd>,
+    PPM extends InferPathParams<REP, EPX>,
+    Opt extends IdentifyParameters<Mtd, EPX, ActualOpt & PPM>,
+    Ret extends InferESIResponseResult<Mtd, EPX>,
+    HasOpt = HasRequireParams<Mtd, EPX, PPM>,
+  >(endpoint: REP, ...options: HasOpt extends 1 ? [Opt] : [Opt?]) => Promise<Ret>;
 
   /**
    * Replaces path parameters in a string with numbers.

package/v2/response-map.d.ts

@@ -9,7 +9,7 @@
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/response-map.d.ts
- * @summary This file is auto-generated and defines version 3.1.0 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.1 of the EVE Online ESI response types.
  */
 import "./types-index.d.ts";
 

package/v2/types-index.d.ts

@@ -9,7 +9,7 @@
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/types-index.d.ts
- * @summary This file is auto-generated and defines version 3.1.0 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.1 of the EVE Online ESI response types.
  */
 import "./get_wars_ok.d.ts";
 import "./get_status_ok.d.ts";