eve-esi-types 2.0.3-beta → 2.0.4-beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "2.0.3-beta",
+  "version": "2.0.4-beta",
   "description": "Extracted the main type of ESI. use for ESI request response types",
   "main": "src/index.d.ts",
   "scripts": {

package/snippet.ts

@@ -0,0 +1,49 @@
+
+import type { TESIResponseOKMap } from "./v2";
+
+type ESIRequestOptions = {
+  /**
+   * query params for ESI request.
+   */
+  queries?: Record<string, any>;
+  /**
+   * will need it for `POST` request etc.
+   */
+  body?: any;
+  /** 
+   * if want response data with ignore error then can be set to `true`.
+   */
+  ignoreError?: boolean;
+  /**
+   * cancel request immediately
+   */
+  cancelable?: AbortController;
+
+  /**
+   * Can be an empty object if no authentication is required.description
+   */
+  token?: string;
+
+  auth?: true;
+};
+// type ESIRequestSig<
+//   POpt extends Record<string, any>,
+//   M extends TESIEntryMethod = TESIEntryMethod,
+//   EP extends keyof TESIResponseOKMap[M] = keyof TESIResponseOKMap[M],
+//   Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], POpt> = IdentifyParameters<TESIResponseOKMap[M][EP], POpt>,
+//   R extends InferESIResponseResult<M, EP> = InferESIResponseResult<M, EP>
+// > = {
+//   method: M;
+//   endpoint: EP;
+//   option: Opt;
+//   result: R;
+// };
+export type ESIRequestSig = <
+  M extends TESIEntryMethod,
+  EP extends keyof TESIResponseOKMap[M],
+  Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>,
+  R extends InferESIResponseResult<M, EP>
+>(
+  method: M, endpoint: EP, pathParams?: number | number[] | Opt,
+  option?: Opt
+) => Promise<R>;

package/v2/get_alliances_alliance_id_contacts_labels_ok.d.ts

@@ -1,6 +1,6 @@
-/**
-* ESI endpoint: /alliances/{alliance_id}/contacts/labels/
-*/
+/*!
+ * ESI endpoint: /alliances/{alliance_id}/contacts/labels/
+ */
 /**
  * 200 ok array
  *
@@ -12,13 +12,13 @@ type GetAlliancesAllianceIdContactsLabelsOk = GetAlliancesAllianceIdContactsLabe
  * 200 ok object
  */
 interface GetAlliancesAllianceIdContactsLabels_200Ok {
-/**
- * label_id integer
- */
+  /**
+   * label_id integer
+   */
   label_id: number;
-/**
- * label_name string
- */
+  /**
+   * label_name string
+   */
   label_name: string;
   [k: string]: unknown | undefined;
 }

package/v2/get_alliances_alliance_id_contacts_ok.d.ts

@@ -1,15 +1,10 @@
-/**
-* ESI endpoint: /alliances/{alliance_id}/contacts/
-*/
+/*!
+ * ESI endpoint: /alliances/{alliance_id}/contacts/
+ */
 /**
  * contact_type string
  */
 type GetAlliancesAllianceIdContactsContactType = "character" | "corporation" | "alliance" | "faction";
-/**
- * label_ids array
- *
- * @maxItems 63
- */
 /**
  * 200 ok array
  *
@@ -21,18 +16,20 @@ type GetAlliancesAllianceIdContactsOk = GetAlliancesAllianceIdContacts_200Ok[];
  * 200 ok object
  */
 interface GetAlliancesAllianceIdContacts_200Ok {
-/**
- * contact_id integer
- */
+  /**
+   * contact_id integer
+   */
   contact_id: number;
   contact_type: GetAlliancesAllianceIdContactsContactType;
-/**
- * Label IDs applied to the contact
- */
+  /**
+   * label_ids array
+   *
+   * @maxItems 63
+   */
   label_ids?: number[];
-/**
- * Standing of the contact
- */
+  /**
+   * Standing of the contact
+   */
   standing: number;
   [k: string]: unknown | undefined;
 }

package/v2/get_alliances_alliance_id_corporations_ok.d.ts

@@ -1,12 +1,9 @@
-/**
-* ESI endpoint: /alliances/{alliance_id}/corporations/
-*/
+/*!
+ * ESI endpoint: /alliances/{alliance_id}/corporations/
+ */
 /**
  * 200 ok array
  *
  * @maxItems 1000
  */
-/**
- * 200 ok integer
- */
 type GetAlliancesAllianceIdCorporationsOk = number[];

package/v2/get_alliances_alliance_id_icons_ok.d.ts

@@ -1,18 +1,18 @@
-/**
-* ESI endpoint: /alliances/{alliance_id}/icons/
-*/
+/*!
+ * ESI endpoint: /alliances/{alliance_id}/icons/
+ */
 
 /**
  * 200 ok object
  */
 interface GetAlliancesAllianceIdIconsOk {
-/**
- * px128x128 string
- */
+  /**
+   * px128x128 string
+   */
   px128x128?: string;
-/**
- * px64x64 string
- */
+  /**
+   * px64x64 string
+   */
   px64x64?: string;
   [k: string]: unknown | undefined;
 }

package/v2/get_alliances_alliance_id_ok.d.ts

@@ -1,38 +1,38 @@
-/**
-* ESI endpoint: /alliances/{alliance_id}/
-*/
+/*!
+ * ESI endpoint: /alliances/{alliance_id}/
+ */
 
 /**
  * 200 ok object
  */
 interface GetAlliancesAllianceIdOk {
-/**
- * ID of the corporation that created the alliance
- */
+  /**
+   * ID of the corporation that created the alliance
+   */
   creator_corporation_id: number;
-/**
- * ID of the character that created the alliance
- */
+  /**
+   * ID of the character that created the alliance
+   */
   creator_id: number;
-/**
- * date_founded string
- */
+  /**
+   * date_founded string
+   */
   date_founded: string;
-/**
- * the executor corporation ID, if this alliance is not closed
- */
+  /**
+   * the executor corporation ID, if this alliance is not closed
+   */
   executor_corporation_id?: number;
-/**
- * Faction ID this alliance is fighting for, if this alliance is enlisted in factional warfare
- */
+  /**
+   * Faction ID this alliance is fighting for, if this alliance is enlisted in factional warfare
+   */
   faction_id?: number;
-/**
- * the full name of the alliance
- */
+  /**
+   * the full name of the alliance
+   */
   name: string;
-/**
- * the short name of the alliance
- */
+  /**
+   * the short name of the alliance
+   */
   ticker: string;
   [k: string]: unknown | undefined;
 }

package/v2/get_alliances_ok.d.ts

@@ -1,12 +1,9 @@
-/**
-* ESI endpoint: /alliances/
-*/
+/*!
+ * ESI endpoint: /alliances/
+ */
 /**
  * 200 ok array
  *
  * @maxItems 5000
  */
-/**
- * 200 ok integer
- */
 type GetAlliancesOk = number[];

package/v2/get_characters_character_id_agents_research_ok.d.ts

@@ -1,6 +1,6 @@
-/**
-* ESI endpoint: /characters/{character_id}/agents_research/
-*/
+/*!
+ * ESI endpoint: /characters/{character_id}/agents_research/
+ */
 /**
  * 200 ok array
  *
@@ -12,25 +12,22 @@ type GetCharactersCharacterIdAgentsResearchOk = GetCharactersCharacterIdAgentsRe
  * 200 ok object
  */
 interface GetCharactersCharacterIdAgentsResearch_200Ok {
-/**
- * agent_id integer
- */
+  /**
+   * agent_id integer
+   */
   agent_id: number;
-/**
- * points_per_day number
- */
+  /**
+   * points_per_day number
+   */
   points_per_day: number;
-/**
- * remainder_points number
- */
+  /**
+   * remainder_points number
+   */
   remainder_points: number;
-/**
- * skill_type_id integer
- */
   skill_type_id: number;
-/**
- * started_at string
- */
+  /**
+   * started_at string
+   */
   started_at: string;
   [k: string]: unknown | undefined;
 }

package/v2/get_characters_character_id_assets_ok.d.ts

@@ -1,6 +1,6 @@
-/**
-* ESI endpoint: /characters/{character_id}/assets/
-*/
+/*!
+ * ESI endpoint: /characters/{character_id}/assets/
+ */
 /**
  * location_flag string
  */
@@ -107,31 +107,28 @@ type GetCharactersCharacterIdAssetsOk = GetCharactersCharacterIdAssets_200Ok[];
  * 200 ok object
  */
 interface GetCharactersCharacterIdAssets_200Ok {
-/**
- * is_blueprint_copy boolean
- */
+  /**
+   * is_blueprint_copy boolean
+   */
   is_blueprint_copy?: boolean;
-/**
- * is_singleton boolean
- */
+  /**
+   * is_singleton boolean
+   */
   is_singleton: boolean;
-/**
- * item_id integer
- */
+  /**
+   * item_id integer
+   */
   item_id: number;
   location_flag: GetCharactersCharacterIdAssetsLocationFlag;
-/**
- * location_id integer
- */
+  /**
+   * location_id integer
+   */
   location_id: number;
   location_type: GetCharactersCharacterIdAssetsLocationType;
-/**
- * quantity integer
- */
+  /**
+   * quantity integer
+   */
   quantity: number;
-/**
- * type_id integer
- */
   type_id: number;
   [k: string]: unknown | undefined;
 }

package/v2/get_characters_character_id_attributes_ok.d.ts

@@ -1,42 +1,42 @@
-/**
-* ESI endpoint: /characters/{character_id}/attributes/
-*/
+/*!
+ * ESI endpoint: /characters/{character_id}/attributes/
+ */
 
 /**
  * 200 ok object
  */
 interface GetCharactersCharacterIdAttributesOk {
-/**
- * Neural remapping cooldown after a character uses remap accrued over time
- */
+  /**
+   * Neural remapping cooldown after a character uses remap accrued over time
+   */
   accrued_remap_cooldown_date?: string;
-/**
- * Number of available bonus character neural remaps
- */
+  /**
+   * Number of available bonus character neural remaps
+   */
   bonus_remaps?: number;
-/**
- * charisma integer
- */
+  /**
+   * charisma integer
+   */
   charisma: number;
-/**
- * intelligence integer
- */
+  /**
+   * intelligence integer
+   */
   intelligence: number;
-/**
- * Datetime of last neural remap, including usage of bonus remaps
- */
+  /**
+   * Datetime of last neural remap, including usage of bonus remaps
+   */
   last_remap_date?: string;
-/**
- * memory integer
- */
+  /**
+   * memory integer
+   */
   memory: number;
-/**
- * perception integer
- */
+  /**
+   * perception integer
+   */
   perception: number;
-/**
- * willpower integer
- */
+  /**
+   * willpower integer
+   */
   willpower: number;
   [k: string]: unknown | undefined;
 }

package/v2/get_characters_character_id_blueprints_ok.d.ts

@@ -1,6 +1,6 @@
-/**
-* ESI endpoint: /characters/{character_id}/blueprints/
-*/
+/*!
+ * ESI endpoint: /characters/{character_id}/blueprints/
+ */
 /**
  * Type of the location_id
  */
@@ -92,34 +92,31 @@ type GetCharactersCharacterIdBlueprintsOk = GetCharactersCharacterIdBlueprints_2
  * 200 ok object
  */
 interface GetCharactersCharacterIdBlueprints_200Ok {
-/**
- * Unique ID for this item.
- */
+  /**
+   * Unique ID for this item.
+   */
   item_id: number;
   location_flag: GetCharactersCharacterIdBlueprintsLocationFlag;
-/**
- * References a station, a ship or an item_id if this blueprint is located within a container. If the return value is an item_id, then the Character AssetList API must be queried to find the container using the given item_id to determine the correct location of the Blueprint.
- */
+  /**
+   * References a station, a ship or an item_id if this blueprint is located within a container. If the return value is an item_id, then the Character AssetList API must be queried to find the container using the given item_id to determine the correct location of the Blueprint.
+   */
   location_id: number;
-/**
- * Material Efficiency Level of the blueprint.
- */
+  /**
+   * Material Efficiency Level of the blueprint.
+   */
   material_efficiency: number;
-/**
- * A range of numbers with a minimum of -2 and no maximum value where -1 is an original and -2 is a copy. It can be a positive integer if it is a stack of blueprint originals fresh from the market (e.g. no activities performed on them yet).
- */
+  /**
+   * A range of numbers with a minimum of -2 and no maximum value where -1 is an original and -2 is a copy. It can be a positive integer if it is a stack of blueprint originals fresh from the market (e.g. no activities performed on them yet).
+   */
   quantity: number;
-/**
- * Number of runs remaining if the blueprint is a copy, -1 if it is an original.
- */
+  /**
+   * Number of runs remaining if the blueprint is a copy, -1 if it is an original.
+   */
   runs: number;
-/**
- * Time Efficiency Level of the blueprint.
- */
+  /**
+   * Time Efficiency Level of the blueprint.
+   */
   time_efficiency: number;
-/**
- * type_id integer
- */
   type_id: number;
   [k: string]: unknown | undefined;
 }

package/v2/get_characters_character_id_bookmarks_folders_ok.d.ts

@@ -1,6 +1,6 @@
-/**
-* ESI endpoint: /characters/{character_id}/bookmarks/folders/
-*/
+/*!
+ * ESI endpoint: /characters/{character_id}/bookmarks/folders/
+ */
 /**
  * 200 ok array
  *
@@ -12,13 +12,13 @@ type GetCharactersCharacterIdBookmarksFoldersOk = GetCharactersCharacterIdBookma
  * 200 ok object
  */
 interface GetCharactersCharacterIdBookmarksFolders_200Ok {
-/**
- * folder_id integer
- */
+  /**
+   * folder_id integer
+   */
   folder_id: number;
-/**
- * name string
- */
+  /**
+   * name string
+   */
   name: string;
   [k: string]: unknown | undefined;
 }

package/v2/get_characters_character_id_bookmarks_ok.d.ts

@@ -1,6 +1,6 @@
-/**
-* ESI endpoint: /characters/{character_id}/bookmarks/
-*/
+/*!
+ * ESI endpoint: /characters/{character_id}/bookmarks/
+ */
 /**
  * 200 ok array
  *
@@ -12,35 +12,35 @@ type GetCharactersCharacterIdBookmarksOk = GetCharactersCharacterIdBookmarks_200
  * 200 ok object
  */
 interface GetCharactersCharacterIdBookmarks_200Ok {
-/**
- * bookmark_id integer
- */
+  /**
+   * bookmark_id integer
+   */
   bookmark_id: number;
   coordinates?: GetCharactersCharacterIdBookmarksCoordinates;
-/**
- * created string
- */
+  /**
+   * created string
+   */
   created: string;
-/**
- * creator_id integer
- */
+  /**
+   * creator_id integer
+   */
   creator_id: number;
-/**
- * folder_id integer
- */
+  /**
+   * folder_id integer
+   */
   folder_id?: number;
   item?: GetCharactersCharacterIdBookmarksItem;
-/**
- * label string
- */
+  /**
+   * label string
+   */
   label: string;
-/**
- * location_id integer
- */
+  /**
+   * location_id integer
+   */
   location_id: number;
-/**
- * notes string
- */
+  /**
+   * notes string
+   */
   notes: string;
   [k: string]: unknown | undefined;
 }
@@ -48,17 +48,17 @@ interface GetCharactersCharacterIdBookmarks_200Ok {
  * Optional object that is returned if a bookmark was made on a planet or a random location in space.
  */
 interface GetCharactersCharacterIdBookmarksCoordinates {
-/**
- * x number
- */
+  /**
+   * x number
+   */
   x: number;
-/**
- * y number
- */
+  /**
+   * y number
+   */
   y: number;
-/**
- * z number
- */
+  /**
+   * z number
+   */
   z: number;
   [k: string]: unknown | undefined;
 }
@@ -66,13 +66,10 @@ interface GetCharactersCharacterIdBookmarksCoordinates {
  * Optional object that is returned if a bookmark was made on a particular item.
  */
 interface GetCharactersCharacterIdBookmarksItem {
-/**
- * item_id integer
- */
+  /**
+   * item_id integer
+   */
   item_id: number;
-/**
- * type_id integer
- */
   type_id: number;
   [k: string]: unknown | undefined;
 }

package/v2/get_characters_character_id_calendar_event_id_attendees_ok.d.ts

@@ -1,6 +1,6 @@
-/**
-* ESI endpoint: /characters/{character_id}/calendar/{event_id}/attendees/
-*/
+/*!
+ * ESI endpoint: /characters/{character_id}/calendar/{event_id}/attendees/
+ */
 /**
  * event_response string
  */
@@ -21,9 +21,9 @@ type GetCharactersCharacterIdCalendarEventIdAttendeesOk =
  * character_id and response of an attendee
  */
 interface GetCharactersCharacterIdCalendarEventIdAttendees_200Ok {
-/**
- * character_id integer
- */
+  /**
+   * character_id integer
+   */
   character_id?: number;
   event_response?: GetCharactersCharacterIdCalendarEventIdAttendeesEventResponse;
   [k: string]: unknown | undefined;