eve-esi-types 3.1.6 → 3.2.0

package/v2/index.d.ts

@@ -9,162 +9,26 @@
  * 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.2.0 of the EVE Online ESI response types.
  */
 import type { TESIResponseOKMap } from "./response-map.d.ts";
-export type { TESIResponseOKMap } from "./response-map.d.ts";
-
 import type { PickPathParameters, InferKeysLen } from "./util.d.ts";
+import type {
+  _ESIResponseType,
+  _IfNeedPathParams,
+  TPathParamsNever,
+  // ESIEndpointUnions,
+  // IESIRequestFunction2,
+  // InferESIResponseResultEX,
+  // InferNextEndpoint2, InferNextEndpointLoos,
+  // InferNextEndpoint,
+  // TESICachedSeconds, TESIRequestFunctionMethods2,
+  // __IdentifyParameters, __InferESIResponseResult,
+} from "./types-util.d.ts";
+export type * from "./response-map.d.ts";
+export type * from "./types-util.d.ts";
+export type * from "./util.d.ts";
 
-/**
- * Represents a function that can make ESI requests with various HTTP methods.
- *
- * @template ActualOpt - The actual type of the options.
- *
- * @example
- * ```ts
- * // @ ts-expect-error
- * export const request: IESIRequestFunction2<ESIRequestOptions> = (method, endpoint, opt) => {
- * // Implementation for "get" | "post" | "put" | "delete" request
- * };
- * // You can easily implement "get" | "post" | "put" | "delete" requests
- * // with code like the following:
- * (["get", "post", "put", "delete"] as (keyof typeof request)[]).forEach((method) => {
- *     request[method] = function (this: typeof request, endpoint, opt) {
- *         return this(method, endpoint, opt);
- *     } as TESIRequestFunctionEachMethod2<typeof method>;
- * });
- * ```
- */
-export interface IESIRequestFunction2<ActualOpt extends Record<string, unknown>>
-  extends TESIRequestFunctionSignature2<ActualOpt>, TESIRequestFunctionMethods2<ActualOpt> {
-}
-
-/**
- * Represents the methods available for making ESI requests.
- * 
- *  + This interface is used when you already have implementation code such as  
- *    TESIRequestFunctionSignature2 and you want to implement additional shorthand methods.
- *
- * @template ActualOpt - The actual type of the options.
- *
- * @example
- * ```ts
- * export const request: TESIRequestFunctionSignature2<ESIRequestOptions> = (method, endpoint, opt) => {
- * // Implementation for "get" | "post" | "put" | "delete" request
- * };
- * // You can easily implement "get" | "post" | "put" | "delete" requests
- * // with code like the following:
- * const esiMethods = {} as TESIRequestFunctionMethods2<ESIRequestOptions>;
- * (["get", "post", "put", "delete"] as (keyof TESIRequestFunctionMethods2)[]).forEach((method) => {
- *     esiMethods[method] = function (endpoint, opt) {
- *         return request(method, endpoint, opt);
- *     } as TESIRequestFunctionEachMethod2<typeof method>;
- * });
- * ```
- */
-export type TESIRequestFunctionMethods2<ActualOpt extends Record<string, unknown>> = {
-  [method in TESIEntryMethod]: TESIRequestFunctionEachMethod2<method, ActualOpt>;
-}
-
-/**
- * List of "x-cached-seconds"
- * 
- * ```ts
- * // const cacheSecGet: 3600 | 300 | 604800 | 120 | 5 | 600 | 86400 | 60 | 30 | 1200 | 1800 | 30758400
- * const cacheSecGet: TESICachedSeconds<"get">;
- * // const cache5sec: 5
- * const cache5s: TESICachedSeconds<"put">;
- * // const cache3600s: 3600
- * const cache3600s: TESICachedSeconds<"post">;
- * // "/characters/affiliation/"
- * const cache3600sEndpoint: TESICachedSeconds<"post", 1>;
- * ```
- */
-export declare type TESICachedSeconds<
-  Method extends TESIEntryMethod, AsEndpoint = void
-> = {
-  [M in TESIEntryMethod]: {
-    [EP in ESIEndpointOf<M>]: TESIResponseOKMap[M][EP] extends { cachedSeconds: number }
-      ? AsEndpoint extends void
-        ? TESIResponseOKMap[M][EP]["cachedSeconds"]: EP
-      : never
-  }[ESIEndpointOf<M>];
-}[Method];
-
-/**
- * Indicates that no path parameters are allowed.
- *
- * This type serves as a compile-time signal for endpoints that do not support dynamic URL segments.  
- * By using this type, it is clear that no path parameters should be provided.
- */
-export declare type TPathParamsNever = { /* pathParams?: never */ };
-
-// local types
-/**
- * Infers the response type of an ESI request based on the HTTP method and endpoint.
- * 
- * This type extracts the response type from the `TESIResponseOKMap` based on the provided
- * HTTP method and endpoint.
- * 
- * @template M - The HTTP method to use for the request.
- * @template EPx - The endpoint path.
- * 
- * @example
- * ```ts
- * type ResponseType = _ESIResponseType<"get", "/characters/{character_id}/">;
- * // Result: The inferred response type for the given method and endpoint.
- * ```
- * @internal
- * @see {@link ESIEndpointOf}
- */
-export type _ESIResponseType<
-  M extends TESIEntryMethod,
-  EPx extends ESIEndpointOf<M> | string,
-> = TESIResponseOKMap[M][Extract<EPx, ESIEndpointOf<M>>];
-// type XOK = _ESIResponseType<"get", "/status/"> extends global._ESIResponseType<"get", "/status/"> ? 1 : 0;
-/**
- * Determines if the endpoint requires path parameters.
- * 
- * @template EP - The string representing the endpoint path.
- * @returns {TPathParamsNever | { pathParams: IfParameterizedPath<EP> }}
- * Returns an object with `pathParams` if the endpoint requires parameters, otherwise returns `TPathParamsNever`.
- * @example
- * ```ts
- * type Example = IfNeedPathParams<"/characters/{character_id}/fittings/{fitting_id}/">;
- * // Result: { pathParams: [number, number] }
- * ```
- * @internal
- * @see {@link IfParameterizedPath}
- * @see {@link ReplacePathParams}
- */
-export type _IfNeedPathParams<EP extends unknown> = IfParameterizedPath<EP> extends never ? TPathParamsNever :
-  EP extends ReplacePathParams<EP> ? TPathParamsNever : { pathParams: IfParameterizedPath<EP> };
-
-/**
- * Infer the result type of an ESI response based on the method and endpoint.
- * 
- * @template M - The HTTP method (e.g., "get", "post").
- * @template EP - The endpoint path.
- * @deprecated 2025/3/17
- */
-export type __InferESIResponseResult<
-  M extends TESIEntryMethod,
-  EP extends ESIEndpointOf<M>
-> = TESIResponseOKMap[M][EP] extends { result: infer U } ? U : never;
-/**
- * Identifies the required parameters for a given entry type.
- *
- * @template Entry - The entry type to identify parameters for.
- * @template Opt - The type of the parameters.
- * @type {Opt & Pick<Entry, Exclude<keyof Entry, "result">>}
- * @deprecated 2025/3/17
- */
-export type __IdentifyParameters<
-  Entry, Opt,
-  Keys = Exclude<keyof Entry, "result" | "tag" | "cachedSeconds">
-  // @ts-expect-error 
-> = RequireThese<Opt, Keys> & Pick<Entry, Keys>;
 
 //  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 //                         Internal types
@@ -218,6 +82,7 @@ type RestrictKeys<
 
 declare global {
 
+  type __ShiftType = 1;
   /**
    * Marks specific properties of a type as required.
    * 
@@ -230,7 +95,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 +172,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 +231,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 +249,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 +273,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 +294,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 +319,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 +344,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 +362,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 +392,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 +431,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,
@@ -610,7 +475,17 @@ declare global {
    * Represents the endpoints for the "delete" method.
    */
   type TEndPointDelete = ESIEndpointOf<"delete">;
+  /**
+   * Union of all `ESIEndpointOf<TESIEntryMethod>`
+   * @date 2025/4/12
+   */
+  type ESIEndpointAll = {
+    [M in TESIEntryMethod]: ESIEndpointOf<M>;
+  }[TESIEntryMethod];
 
+  // type TESIResponseEntries<
+  //   M extends TESIEntryMethod, EP extends ESIEndpointOf<M>
+  // > = TESIResponseOKMap[M][EP];
   /**
    * Represents the entry details for the "get" method.
    * 

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.2.0 of the EVE Online ESI response types.
  */
 import "./types-index.d.ts";
 
@@ -285,13 +285,6 @@ export type TESIResponseOKMap = {
       tag: "Location";
       cachedSeconds: 60;
     },
-    "/characters/{character_id}/opportunities/": {
-      result: GetCharactersCharacterIdOpportunitiesOk;
-      /** `esi-characters.read_opportunities.v1` */
-      auth: true;
-      tag: "Opportunities";
-      cachedSeconds: 3600;
-    },
     "/characters/{character_id}/orders/": {
       result: GetCharactersCharacterIdOrdersOk;
       /** `esi-markets.read_character_orders.v1` */
@@ -831,22 +824,6 @@ export type TESIResponseOKMap = {
       tag: "Market";
       cachedSeconds: 600;
     },
-    "/opportunities/groups/": {
-      result: GetOpportunitiesGroupsOk;
-      tag: "Opportunities";
-    },
-    "/opportunities/groups/{group_id}/": {
-      result: GetOpportunitiesGroupsGroupIdOk;
-      tag: "Opportunities";
-    },
-    "/opportunities/tasks/": {
-      result: GetOpportunitiesTasksOk;
-      tag: "Opportunities";
-    },
-    "/opportunities/tasks/{task_id}/": {
-      result: GetOpportunitiesTasksTaskIdOk;
-      tag: "Opportunities";
-    },
     "/route/{origin}/{destination}/": {
       result: GetRouteOriginDestinationOk;
       query: {
@@ -1025,16 +1002,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 +1020,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 +1152,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 +1172,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";
     }
   }
 };