eve-esi-types 3.1.6 → 3.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "3.1.6",
+  "version": "3.1.7",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
   "main": "v2/index.d.ts",
   "scripts": {
@@ -15,7 +15,6 @@
     "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.6 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.7 of the EVE Online ESI response types.
  */
 import { TESIResponseOKMap } from "./index.d.ts";
 export * from "./index.d.ts";

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.6 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.7 of the EVE Online ESI response types.
  */
 import type { TESIResponseOKMap } from "./response-map.d.ts";
 export type { TESIResponseOKMap } from "./response-map.d.ts";
@@ -230,7 +230,7 @@ declare global {
    * type RequiredA = RequireThese<Original, 'a'>;
    * // Result: { a: number; b?: string; c: boolean }
    * ```
-   * @see Documentation of [`RequireThese`](../docs/v2/require-these.md)
+   * @see Documentation of [`RequireThese`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v2/require-these.md)
    */
   type RequireThese<T, K extends keyof T> = {
     [P in keyof T as P extends K ? P : never]-?: T[P];
@@ -307,7 +307,7 @@ declare global {
    *   otherwise optional.
    *
    * @returns {Promise<Ret>} A promise that resolves with the result type `Ret`, representing the response data from the ESI endpoint.
-   * @see Documentation of [`TESIEnhancedRequestFunctionSignature`](../docs/v3/esi-enhanced-function-signature.md)
+   * @see Documentation of [`TESIEnhancedRequestFunctionSignature`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v3/esi-enhanced-function-signature.md)
    */
   type TESIEnhancedRequestFunctionSignature<
     PrependParam extends unknown, ActualOpt extends Record<string, unknown>
@@ -366,7 +366,7 @@ declare global {
    * type Example = ReplacePathParams<"/characters/{character_id}/fittings/{fitting_id}/">;
    * // Result: `/characters/${number}/fittings/${number}/`
    * ```
-   * @see Documentation of [`ReplacePathParams`](../docs/v3/replace-path-params.md)
+   * @see Documentation of [`ReplacePathParams`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v3/replace-path-params.md)
    */
   type ReplacePathParams<T extends unknown> = T extends `${infer Start}{${infer Param}}${infer End}`
     ? `${Start}${number}${ReplacePathParams<End>}` : T;
@@ -384,7 +384,7 @@ declare global {
    * @returns {TPathParamsNever | _IfNeedPathParams<EPx>}
    * @see {@link _IfNeedPathParams}
    * @see {@link TPathParamsNever}
-   * @see Documentation of [`InferPathParams`](../docs/v3/infer-path-params.md)
+   * @see Documentation of [`InferPathParams`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v3/infer-path-params.md)
    * @date 2025/3/17
    */
   type InferPathParams<
@@ -408,7 +408,7 @@ declare global {
    * ```
    * @see {@link ESIEndpointOf}
    * @see {@link ReplacePathParams}
-   * @see Documentation of [`InferEndpointOrigin`](../docs/v3/infer-endpoint-origin.md)
+   * @see Documentation of [`InferEndpointOrigin`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v3/infer-endpoint-origin.md)
    */
   type InferEndpointOrigin<
     RealEP extends unknown, M extends TESIEntryMethod,
@@ -429,7 +429,7 @@ declare global {
    * // Result: "/characters/{character_id}/fittings/{fitting_id}/"
    * ```
    * @see {@link InferEndpointOrigin}
-   * @see Documentation of [`ResolvedEndpoint`](../docs/v3/resolved-endpoint.md)
+   * @see Documentation of [`ResolvedEndpoint`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v3/resolved-endpoint.md)
    */
   type ResolvedEndpoint<
     RealEP extends unknown, M extends TESIEntryMethod,
@@ -454,7 +454,7 @@ declare global {
    * ```
    * @see {@link ESIEndpointOf}
    * @see {@link _ESIResponseType}
-   * @see Documentation of [`PickRequireParams`](../docs/v3/pick-require-params.md)
+   * @see Documentation of [`PickRequireParams`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v3/pick-require-params.md)
    */
   type PickRequireParams<
     M extends TESIEntryMethod,
@@ -479,7 +479,7 @@ declare global {
    * ```
    * @see {@link ESIEndpointOf}
    * @see {@link PickRequireParams}
-   * @see Documentation of [`HasRequireParams`](../docs/v3/has-require-params.md)
+   * @see Documentation of [`HasRequireParams`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v3/has-require-params.md)
    */
   type HasRequireParams<
     M extends TESIEntryMethod,
@@ -497,7 +497,7 @@ declare global {
    * @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`.
-   * @see Documentation of [`IfParameterizedPath`](../docs/v2/if-parameterized-path.md)
+   * @see Documentation of [`IfParameterizedPath`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v2/if-parameterized-path.md)
    */
   type IfParameterizedPath<EP extends unknown, Opt = never> = EP extends `${string}/{${string}}${string}`
     ? PickPathParameters<EP> extends never
@@ -527,7 +527,7 @@ declare global {
    * @see {@link RequireThese}
    * @see {@link ESIEndpointOf}
    * @see {@link _ESIResponseType}
-   * @see Documentation of [`IdentifyParameters`](../docs/v2/identify-parameters.md)
+   * @see Documentation of [`IdentifyParameters`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v2/identify-parameters.md)
    */
   //* ctt
   type IdentifyParameters<
@@ -566,7 +566,7 @@ declare global {
    * ```
    * @see {@link ESIEndpointOf}
    * @see {@link _ESIResponseType}
-   * @see Documentation of [`InferESIResponseResult`](../docs/v2/infer-esi-response-result.md)
+   * @see Documentation of [`InferESIResponseResult`](https://github.com/jeffy-g/eve-esi-types/blob/master/docs/v2/infer-esi-response-result.md)
    */
   type InferESIResponseResult<
     M extends TESIEntryMethod,

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.6 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.7 of the EVE Online ESI response types.
  */
 import "./types-index.d.ts";
 
@@ -1025,16 +1025,16 @@ export type TESIResponseOKMap = {
   post: {
     "/fleets/{fleet_id}/members/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
       body: PostFleetsFleetIdMembersInvitation;
     },
     "/ui/autopilot/waypoint/": {
       result: NoContentResponse;
+      tag: "User Interface";
       /** `esi-ui.write_waypoint.v1` */
       auth: true;
-      tag: "User Interface";
       query: {
         add_to_beginning: boolean;
         clear_other_waypoints: boolean;
@@ -1043,36 +1043,36 @@ export type TESIResponseOKMap = {
     },
     "/ui/openwindow/contract/": {
       result: NoContentResponse;
+      tag: "User Interface";
       /** `esi-ui.open_window.v1` */
       auth: true;
-      tag: "User Interface";
       query: {
         contract_id: number;
       }
     },
     "/ui/openwindow/information/": {
       result: NoContentResponse;
+      tag: "User Interface";
       /** `esi-ui.open_window.v1` */
       auth: true;
-      tag: "User Interface";
       query: {
         target_id: number;
       }
     },
     "/ui/openwindow/marketdetails/": {
       result: NoContentResponse;
+      tag: "User Interface";
       /** `esi-ui.open_window.v1` */
       auth: true;
-      tag: "User Interface";
       query: {
         type_id: number;
       }
     },
     "/ui/openwindow/newmail/": {
       result: NoContentResponse;
+      tag: "User Interface";
       /** `esi-ui.open_window.v1` */
       auth: true;
-      tag: "User Interface";
       body: PostUiOpenwindowNewmailNewMail;
     },
     "/characters/affiliation/": {
@@ -1175,17 +1175,17 @@ export type TESIResponseOKMap = {
   put: {
     "/characters/{character_id}/calendar/{event_id}/": {
       result: NoContentResponse;
-      /** `esi-calendar.respond_calendar_events.v1` */
-      auth: true;
       tag: "Calendar";
       cachedSeconds: 5;
+      /** `esi-calendar.respond_calendar_events.v1` */
+      auth: true;
       body: PutCharactersCharacterIdCalendarEventIdResponse;
     },
     "/characters/{character_id}/contacts/": {
       result: NoContentResponse;
+      tag: "Contacts";
       /** `esi-characters.write_contacts.v1` */
       auth: true;
-      tag: "Contacts";
       body: PutCharactersCharacterIdContactsContactIds;
       query: {
         label_ids?: PutCharactersCharacterIdContactsLabelIds;
@@ -1195,85 +1195,85 @@ export type TESIResponseOKMap = {
     },
     "/characters/{character_id}/mail/{mail_id}/": {
       result: NoContentResponse;
+      tag: "Mail";
       /** `esi-mail.organize_mail.v1` */
       auth: true;
-      tag: "Mail";
       body: PutCharactersCharacterIdMailMailIdContents;
     },
     "/fleets/{fleet_id}/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
       body: PutFleetsFleetIdNewSettings;
     },
     "/fleets/{fleet_id}/members/{member_id}/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
       body: PutFleetsFleetIdMembersMemberIdMovement;
     },
     "/fleets/{fleet_id}/squads/{squad_id}/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
       body: PutFleetsFleetIdSquadsSquadIdNaming;
     },
     "/fleets/{fleet_id}/wings/{wing_id}/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
       body: PutFleetsFleetIdWingsWingIdNaming;
     }
   },
   delete: {
     "/characters/{character_id}/contacts/": {
       result: NoContentResponse;
+      tag: "Contacts";
       /** `esi-characters.write_contacts.v1` */
       auth: true;
-      tag: "Contacts";
       query: {
         contact_ids: DeleteCharactersCharacterIdContactsContactIds;
       }
     },
     "/characters/{character_id}/fittings/{fitting_id}/": {
       result: NoContentResponse;
+      tag: "Fittings";
       /** `esi-fittings.write_fittings.v1` */
       auth: true;
-      tag: "Fittings";
     },
     "/characters/{character_id}/mail/labels/{label_id}/": {
       result: NoContentResponse;
+      tag: "Mail";
       /** `esi-mail.organize_mail.v1` */
       auth: true;
-      tag: "Mail";
     },
     "/characters/{character_id}/mail/{mail_id}/": {
       result: NoContentResponse;
+      tag: "Mail";
       /** `esi-mail.organize_mail.v1` */
       auth: true;
-      tag: "Mail";
     },
     "/fleets/{fleet_id}/members/{member_id}/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
     },
     "/fleets/{fleet_id}/squads/{squad_id}/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
     },
     "/fleets/{fleet_id}/wings/{wing_id}/": {
       result: NoContentResponse;
+      tag: "Fleets";
       /** `esi-fleets.write_fleet.v1` */
       auth: true;
-      tag: "Fleets";
     }
   }
 };

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.6 of the EVE Online ESI response types.
+ * @summary This file is auto-generated and defines version 3.1.7 of the EVE Online ESI response types.
  */
 import "./get_wars_ok.d.ts";
 import "./get_status_ok.d.ts";

package/docs/esi-tagged-types.md

@@ -1,120 +0,0 @@
-# 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/docs/v2/identify-parameters.md

@@ -1,74 +0,0 @@
-# Explanation of the `IdentifyParameters` Type
-
-`IdentifyParameters` is an advanced TypeScript utility type designed to pinpoint the required parameters for an API endpoint by combining the key properties from the entry type and any additional options. This type ensures that all required parameters are explicitly marked as required, facilitating strong type-checking for API operations.
-
-## Type Definition
-
-```typescript
-type IdentifyParameters<
-  M extends TESIEntryMethod,
-  EPx extends ESIEndpointOf<M> | string,
-  Opt extends Record<string, unknown>,
-  AdditionalParams,
-  Entry = _ESIResponseType<M, EPx> & AdditionalParams,
-  RequireKeys = Exclude<keyof (Entry & AdditionalParams), "result" | "tag" | "cachedSeconds">
-  // @ts-expect-error 
-> = RestrictKeys<Opt, RequireKeys> & Pick<Entry, RequireKeys> & AdditionalParams;
-```
-
-## Template Parameters
-
-- **`M extends TESIEntryMethod`**  
-  Specifies the HTTP method (e.g., `"get"`, `"post"`, `"delete"`, etc.) used for the API request. This allows the type system to select the appropriate endpoint and response types.
-
-- **`EPx extends ESIEndpointOf<M> | string`**  
-  Denotes the endpoint path. It can be a specific parameterized endpoint corresponding to the method or a generic endpoint represented as a string.
-
-- **`Opt extends Record<string, unknown>`**  
-  Represents the additional options provided by the user. These options are expected to be an object whose keys are strings.
-
-- **`AdditionalParams`**  
-  These are extra parameters that, when merged with the entry type, give a more comprehensive view of the API parameters.
-
-- **`Entry = _ESIResponseType<M, EPx> & AdditionalParams`**  
-  This type combines the inferred response type for the given HTTP method and endpoint with the additional parameters. It serves as the base type from which the required keys are extracted.
-
-- **`RequireKeys = Exclude<keyof (Entry & AdditionalParams), "result" | "tag" | "cachedSeconds">`**  
-  This calculates the keys that are considered required by excluding common metadata keys (`"result"`, `"tag"`, and `"cachedSeconds"`) from the combined type.
-
-## How It Works
-
-1. **Merging Types**  
-   The type first merges the API response type (`_ESIResponseType<M, EPx>`) with any additional parameters passed as `AdditionalParams` to form the composite type `Entry`.
-
-2. **Identifying Required Keys**  
-   It then computes `RequireKeys` by taking the keys of the merged type and excluding the metadata keys (`"result"`, `"tag"`, `"cachedSeconds"`). These remaining keys are treated as required parameters.
-
-3. **Restricting Additional Options**  
-   The helper type `RestrictKeys<Opt, RequireKeys>` ensures that the additional options in `Opt` are limited only to the keys identified as required. This adds an extra layer of type-safety.
-
-4. **Final Combination**  
-   Finally, the type returns the intersection:
-   - `RestrictKeys<Opt, RequireKeys>` restricts `Opt` to only the required keys.
-   - `Pick<Entry, RequireKeys>` extracts the corresponding values from the merged entry type.
-   - `AdditionalParams` is intersected in the end, ensuring that any extra provided parameters are also included.
-   
-   This results in a final type that accurately represents only the required parameters for an API endpoint.
-
-## Practical Example
-
-```typescript
-type ExampleEntry = { result: string, tag: string, cachedSeconds: number, auth: string };
-type ExampleOpt = { auth: string };
-type IdentifiedParams = IdentifyParameters<"get", "/example/endpoint", ExampleOpt, ExampleEntry>;
-// Result: { auth: string } & { auth: string }
-```
-
-In this example:
-- `ExampleEntry` includes metadata keys along with the essential key `auth`.
-- `ExampleOpt` specifies that `auth` is required.
-- `IdentifyParameters` processes these inputs and produces a type that enforces the `auth` parameter as required, ensuring accurate and reliable type-checking.
-
----
-
-`IdentifyParameters` thus plays a crucial role in extracting and enforcing the required parameters from API definitions, merging inherent parameters with additional options into a concise, strongly-typed structure.

package/docs/v2/if-parameterized-path.md

@@ -1,70 +0,0 @@
-# Explanation of the `IfParameterizedPath` Type
-
-`IfParameterizedPath` is a conditional TypeScript utility type that checks whether a given endpoint path (`EP`) is parameterized—i.e., contains a parameterized segment enclosed in `{}`—and, if so, determines the required type for its numeric replacements. Depending on the number of parameters detected, it returns different types:
-- Returns `number` if exactly one parameter is detected.
-- Returns `[number, number]` if two parameters are detected.
-- Otherwise, it returns the fallback type `Opt` (which defaults to `never`).
-
-## Type Definition
-
-```typescript
-type IfParameterizedPath<EP extends unknown, Opt = never> = EP extends `${string}/{${string}}${string}`
-  ? PickPathParameters<EP> extends never
-      ? Opt : InferKeysLen<PickPathParameters<EP>> extends 1
-        ? number : [number, number]
-  : Opt;
-```
-
-## Template Parameters
-
-- **`EP extends unknown`**  
-  The endpoint path as a string literal. This path may contain dynamic segments (e.g., `"/users/{user_id}/posts/{post_id}"`) that need to be replaced with numerical values.
-
-- **`Opt`**  
-  The fallback type to return if `EP` is not parameterized. By default, this is set to `never`.
-
-## How It Works
-
-1. **Pattern Matching**  
-   The type checks if `EP` matches the pattern:
-   ```typescript
-   EP extends `${string}/{${string}}${string}`
-   ```
-   This verifies that `EP` includes at least one parameter wrapped in curly braces.
-
-2. **Extracting Parameters**  
-   If `EP` is parameterized, `PickPathParameters<EP>` is used to extract the dynamic segments:
-   - If `PickPathParameters<EP>` evaluates to `never` (indicating no valid parameters were found), the type returns `Opt`.
-   - Otherwise, it proceeds to the next step.
-
-3. **Determining the Number of Parameters**  
-   The type uses `InferKeysLen<PickPathParameters<EP>>` to count the number of extracted parameters:
-   - If exactly one parameter is found, it returns `number`—indicating a single numeric replacement.
-   - Otherwise (implicitly for two parameters as per the provided description), it returns `[number, number]`.
-
-4. **Fallback for Non-Parameterized Paths**  
-   If `EP` does not match the parameterized pattern, the type simply returns `Opt`.
-
-## Practical Example
-
-For an endpoint with one parameter:
-```typescript
-type SingleParam = IfParameterizedPath<"/users/{user_id}/profile">;
-// Evaluates to: number
-```
-
-For an endpoint with two parameters:
-```typescript
-type TwoParams = IfParameterizedPath<"/users/{user_id}/posts/{post_id}">;
-// Evaluates to: [number, number]
-```
-
-And for a non-parameterized endpoint:
-```typescript
-type NotParam = IfParameterizedPath<"/about">;
-// Evaluates to: never (using the default for Opt)
-```
-
----
-
-`IfParameterizedPath` provides a precise mechanism for type-level validation of endpoint structures by determining the necessary numerical replacements for dynamic segments, ensuring robust type-checking for API endpoint definitions.

package/docs/v2/infer-esi-response-result.md

@@ -1,44 +0,0 @@
-# Explanation of the `InferESIResponseResult` Type
-
-`InferESIResponseResult` is a utility TypeScript type designed to extract the type of the `result` property from an ESI response based on a given HTTP method and endpoint. It relies on the underlying `_ESIResponseType`, which represents the full response type for the specified method and endpoint. If this inferred response type includes a `result` key, the type captures and returns its type; otherwise, it defaults to `never`.
-
-## Type Definition
-
-```typescript
-type InferESIResponseResult<
-  M extends TESIEntryMethod,
-  EPx extends ESIEndpointOf<M> | string
-> = _ESIResponseType<M, EPx> extends { result: infer U } ? U : never;
-```
-
-## Template Parameters
-
-- **`M extends TESIEntryMethod`**  
-  The HTTP method (e.g., `"get"`, `"post"`, `"delete"`, etc.) used for the request. This helps determine the proper response type from the API endpoints.
-
-- **`EPx extends ESIEndpointOf<M> | string`**  
-  The endpoint path, which can either be one of the predefined parameterized endpoints associated with the HTTP method `M` or a generic string representing an endpoint.
-
-## How It Works
-
-1. **Inferring the Response Type:**  
-   The type first evaluates `_ESIResponseType<M, EPx>`, which returns the anticipated response type for the given HTTP method and endpoint.
-
-2. **Extracting the `result` Property:**  
-   It then uses a conditional type with the `infer` keyword:
-   ```typescript
-   _ESIResponseType<M, EPx> extends { result: infer U } ? U : never;
-   ```
-   - If the response type has a `result` property, `U` is inferred as the type of that property.
-   - If there is no `result` property, the type evaluates to `never`.
-
-## Practical Example
-
-```typescript
-type Result = InferESIResponseResult<"get", "/characters/{character_id}/">;
-// The type 'Result' represents the type of the 'result' field in the response for the GET request to the specified endpoint.
-```
-
----
-
-`InferESIResponseResult` enhances type safety by allowing developers to directly access the portion of the API response that contains the primary data of interest. This makes it easier to work with and validate the structure of responses in a strongly-typed manner.