eve-esi-types 2.2.1 → 2.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2/index.d.ts CHANGED
@@ -9,192 +9,188 @@
9
9
  * THIS TSD IS AUTO GENERATED, DO NOT EDIT
10
10
  *
11
11
  * @file eve-esi-types/v2/index.d.ts
12
- * @summary This file is auto-generated and defines version 2.2.1 of the EVE Online ESI response types.
12
+ * @summary This file is auto-generated and defines version 2.2.5 of the EVE Online ESI response types.
13
13
  */
14
+ import "./get_wars_ok.d.ts";
15
+ import "./get_status_ok.d.ts";
16
+ import "./get_fw_wars_ok.d.ts";
17
+ import "./get_fw_stats_ok.d.ts";
14
18
  import "./get_alliances_ok.d.ts";
19
+ import "./get_fw_systems_ok.d.ts";
20
+ import "./get_incursions_ok.d.ts";
21
+ import "./get_wars_war_id_ok.d.ts";
22
+ import "./get_dogma_effects_ok.d.ts";
23
+ import "./post_universe_ids_ok.d.ts";
24
+ import "./get_markets_groups_ok.d.ts";
25
+ import "./get_markets_prices_ok.d.ts";
26
+ import "./get_universe_races_ok.d.ts";
27
+ import "./get_universe_types_ok.d.ts";
28
+ import "./get_fleets_fleet_id_ok.d.ts";
29
+ import "./get_fw_leaderboards_ok.d.ts";
30
+ import "./get_sovereignty_map_ok.d.ts";
31
+ import "./get_universe_groups_ok.d.ts";
32
+ import "./post_universe_names_ok.d.ts";
33
+ import "./get_dogma_attributes_ok.d.ts";
34
+ import "./get_industry_systems_ok.d.ts";
35
+ import "./get_insurance_prices_ok.d.ts";
36
+ import "./get_universe_regions_ok.d.ts";
37
+ import "./get_universe_systems_ok.d.ts";
38
+ import "./get_universe_factions_ok.d.ts";
39
+ import "./get_universe_graphics_ok.d.ts";
40
+ import "./get_industry_facilities_ok.d.ts";
41
+ import "./get_opportunities_tasks_ok.d.ts";
42
+ import "./get_universe_ancestries_ok.d.ts";
43
+ import "./get_universe_bloodlines_ok.d.ts";
44
+ import "./get_universe_categories_ok.d.ts";
45
+ import "./get_universe_structures_ok.d.ts";
46
+ import "./get_opportunities_groups_ok.d.ts";
15
47
  import "./get_alliances_alliance_id_ok.d.ts";
16
- import "./get_alliances_alliance_id_contacts_ok.d.ts";
17
- import "./get_alliances_alliance_id_contacts_labels_ok.d.ts";
18
- import "./get_alliances_alliance_id_corporations_ok.d.ts";
19
- import "./get_alliances_alliance_id_icons_ok.d.ts";
48
+ import "./get_corporations_npccorps_ok.d.ts";
49
+ import "./get_fleets_fleet_id_wings_ok.d.ts";
50
+ import "./get_sovereignty_campaigns_ok.d.ts";
51
+ import "./get_universe_system_jumps_ok.d.ts";
52
+ import "./get_universe_system_kills_ok.d.ts";
53
+ import "./get_wars_war_id_killmails_ok.d.ts";
54
+ import "./get_sovereignty_structures_ok.d.ts";
55
+ import "./get_universe_moons_moon_id_ok.d.ts";
56
+ import "./get_universe_stars_star_id_ok.d.ts";
57
+ import "./get_universe_types_type_id_ok.d.ts";
20
58
  import "./post_characters_affiliation_ok.d.ts";
21
59
  import "./get_characters_character_id_ok.d.ts";
22
- import "./get_characters_character_id_agents_research_ok.d.ts";
60
+ import "./get_dogma_effects_effect_id_ok.d.ts";
61
+ import "./get_fleets_fleet_id_members_ok.d.ts";
62
+ import "./get_markets_region_id_types_ok.d.ts";
63
+ import "./get_universe_constellations_ok.d.ts";
64
+ import "./get_markets_region_id_orders_ok.d.ts";
65
+ import "./get_route_origin_destination_ok.d.ts";
66
+ import "./get_universe_groups_group_id_ok.d.ts";
67
+ import "./get_markets_region_id_history_ok.d.ts";
68
+ import "./get_contracts_public_region_id_ok.d.ts";
69
+ import "./get_fw_leaderboards_characters_ok.d.ts";
70
+ import "./get_universe_planets_planet_id_ok.d.ts";
71
+ import "./get_universe_regions_region_id_ok.d.ts";
72
+ import "./get_universe_systems_system_id_ok.d.ts";
73
+ import "./get_alliances_alliance_id_icons_ok.d.ts";
74
+ import "./get_corporations_corporation_id_ok.d.ts";
75
+ import "./post_fleets_fleet_id_wings_created.d.ts";
76
+ import "./get_opportunities_tasks_task_id_ok.d.ts";
77
+ import "./get_characters_character_id_mail_ok.d.ts";
78
+ import "./get_characters_character_id_ship_ok.d.ts";
79
+ import "./get_fw_leaderboards_corporations_ok.d.ts";
80
+ import "./get_universe_graphics_graphic_id_ok.d.ts";
81
+ import "./get_universe_stations_station_id_ok.d.ts";
82
+ import "./get_characters_character_id_fleet_ok.d.ts";
83
+ import "./get_characters_character_id_roles_ok.d.ts";
84
+ import "./get_dogma_attributes_attribute_id_ok.d.ts";
85
+ import "./get_opportunities_groups_group_id_ok.d.ts";
86
+ import "./get_alliances_alliance_id_contacts_ok.d.ts";
23
87
  import "./get_characters_character_id_assets_ok.d.ts";
24
- import "./post_characters_character_id_assets_locations_ok.d.ts";
25
- import "./post_characters_character_id_assets_names_ok.d.ts";
26
- import "./get_characters_character_id_attributes_ok.d.ts";
27
- import "./get_characters_character_id_blueprints_ok.d.ts";
28
- import "./get_characters_character_id_bookmarks_ok.d.ts";
29
- import "./get_characters_character_id_bookmarks_folders_ok.d.ts";
30
- import "./get_characters_character_id_calendar_ok.d.ts";
31
- import "./get_characters_character_id_calendar_event_id_ok.d.ts";
32
- import "./get_characters_character_id_calendar_event_id_attendees_ok.d.ts";
33
88
  import "./get_characters_character_id_clones_ok.d.ts";
34
- import "./get_characters_character_id_contacts_ok.d.ts";
35
- import "./post_characters_character_id_contacts_created.d.ts";
36
- import "./get_characters_character_id_contacts_labels_ok.d.ts";
37
- import "./get_characters_character_id_contracts_ok.d.ts";
38
- import "./get_characters_character_id_contracts_contract_id_bids_ok.d.ts";
39
- import "./get_characters_character_id_contracts_contract_id_items_ok.d.ts";
40
- import "./get_characters_character_id_corporationhistory_ok.d.ts";
41
- import "./post_characters_character_id_cspa_created.d.ts";
42
- import "./get_characters_character_id_fatigue_ok.d.ts";
43
- import "./get_characters_character_id_fittings_ok.d.ts";
44
- import "./post_characters_character_id_fittings_created.d.ts";
45
- import "./get_characters_character_id_fleet_ok.d.ts";
46
- import "./get_characters_character_id_fw_stats_ok.d.ts";
47
- import "./get_characters_character_id_implants_ok.d.ts";
48
- import "./get_characters_character_id_industry_jobs_ok.d.ts";
49
- import "./get_characters_character_id_killmails_recent_ok.d.ts";
50
- import "./get_characters_character_id_location_ok.d.ts";
51
- import "./get_characters_character_id_loyalty_points_ok.d.ts";
52
- import "./get_characters_character_id_mail_ok.d.ts";
53
- import "./post_characters_character_id_mail_created.d.ts";
54
- import "./get_characters_character_id_mail_labels_ok.d.ts";
55
- import "./post_characters_character_id_mail_labels_created.d.ts";
56
- import "./get_characters_character_id_mail_lists_ok.d.ts";
57
- import "./get_characters_character_id_mail_mail_id_ok.d.ts";
58
89
  import "./get_characters_character_id_medals_ok.d.ts";
59
90
  import "./get_characters_character_id_mining_ok.d.ts";
60
- import "./get_characters_character_id_notifications_ok.d.ts";
61
- import "./get_characters_character_id_notifications_contacts_ok.d.ts";
62
91
  import "./get_characters_character_id_online_ok.d.ts";
63
- import "./get_characters_character_id_opportunities_ok.d.ts";
64
92
  import "./get_characters_character_id_orders_ok.d.ts";
65
- import "./get_characters_character_id_orders_history_ok.d.ts";
66
- import "./get_characters_character_id_planets_ok.d.ts";
67
- import "./get_characters_character_id_planets_planet_id_ok.d.ts";
68
- import "./get_characters_character_id_portrait_ok.d.ts";
69
- import "./get_characters_character_id_roles_ok.d.ts";
70
93
  import "./get_characters_character_id_search_ok.d.ts";
71
- import "./get_characters_character_id_ship_ok.d.ts";
72
- import "./get_characters_character_id_skillqueue_ok.d.ts";
73
94
  import "./get_characters_character_id_skills_ok.d.ts";
74
- import "./get_characters_character_id_standings_ok.d.ts";
75
95
  import "./get_characters_character_id_titles_ok.d.ts";
76
96
  import "./get_characters_character_id_wallet_ok.d.ts";
77
- import "./get_characters_character_id_wallet_journal_ok.d.ts";
78
- import "./get_characters_character_id_wallet_transactions_ok.d.ts";
97
+ import "./get_markets_groups_market_group_id_ok.d.ts";
98
+ import "./get_universe_stargates_stargate_id_ok.d.ts";
99
+ import "./get_characters_character_id_fatigue_ok.d.ts";
100
+ import "./get_characters_character_id_planets_ok.d.ts";
101
+ import "./get_markets_structures_structure_id_ok.d.ts";
102
+ import "./get_universe_categories_category_id_ok.d.ts";
103
+ import "./get_characters_character_id_calendar_ok.d.ts";
104
+ import "./get_characters_character_id_contacts_ok.d.ts";
105
+ import "./get_characters_character_id_fittings_ok.d.ts";
106
+ import "./get_characters_character_id_fw_stats_ok.d.ts";
107
+ import "./get_characters_character_id_implants_ok.d.ts";
108
+ import "./get_characters_character_id_location_ok.d.ts";
109
+ import "./get_characters_character_id_portrait_ok.d.ts";
110
+ import "./get_universe_schematics_schematic_id_ok.d.ts";
111
+ import "./get_universe_structures_structure_id_ok.d.ts";
112
+ import "./get_characters_character_id_contracts_ok.d.ts";
113
+ import "./get_characters_character_id_standings_ok.d.ts";
79
114
  import "./get_contracts_public_bids_contract_id_ok.d.ts";
115
+ import "./get_corporations_corporation_id_icons_ok.d.ts";
116
+ import "./get_corporations_corporation_id_roles_ok.d.ts";
117
+ import "./get_alliances_alliance_id_corporations_ok.d.ts";
118
+ import "./get_characters_character_id_attributes_ok.d.ts";
119
+ import "./get_characters_character_id_blueprints_ok.d.ts";
120
+ import "./post_characters_character_id_cspa_created.d.ts";
121
+ import "./post_characters_character_id_mail_created.d.ts";
122
+ import "./get_characters_character_id_mail_lists_ok.d.ts";
123
+ import "./get_characters_character_id_skillqueue_ok.d.ts";
80
124
  import "./get_contracts_public_items_contract_id_ok.d.ts";
81
- import "./get_contracts_public_region_id_ok.d.ts";
82
- import "./get_corporation_corporation_id_mining_extractions_ok.d.ts";
83
- import "./get_corporation_corporation_id_mining_observers_ok.d.ts";
84
- import "./get_corporation_corporation_id_mining_observers_observer_id_ok.d.ts";
85
- import "./get_corporations_npccorps_ok.d.ts";
86
- import "./get_corporations_corporation_id_ok.d.ts";
87
- import "./get_corporations_corporation_id_alliancehistory_ok.d.ts";
88
125
  import "./get_corporations_corporation_id_assets_ok.d.ts";
89
- import "./post_corporations_corporation_id_assets_locations_ok.d.ts";
90
- import "./post_corporations_corporation_id_assets_names_ok.d.ts";
91
- import "./get_corporations_corporation_id_blueprints_ok.d.ts";
92
- import "./get_corporations_corporation_id_bookmarks_ok.d.ts";
93
- import "./get_corporations_corporation_id_bookmarks_folders_ok.d.ts";
126
+ import "./get_corporations_corporation_id_medals_ok.d.ts";
127
+ import "./get_corporations_corporation_id_orders_ok.d.ts";
128
+ import "./get_corporations_corporation_id_titles_ok.d.ts";
129
+ import "./get_characters_character_id_mail_labels_ok.d.ts";
130
+ import "./get_corporations_corporation_id_members_ok.d.ts";
131
+ import "./get_corporations_corporation_id_wallets_ok.d.ts";
132
+ import "./get_dogma_dynamic_items_type_id_item_id_ok.d.ts";
133
+ import "./get_killmails_killmail_id_killmail_hash_ok.d.ts";
134
+ import "./get_characters_character_id_mail_mail_id_ok.d.ts";
94
135
  import "./get_corporations_corporation_id_contacts_ok.d.ts";
95
- import "./get_corporations_corporation_id_contacts_labels_ok.d.ts";
96
- import "./get_corporations_corporation_id_containers_logs_ok.d.ts";
136
+ import "./get_corporations_corporation_id_fw_stats_ok.d.ts";
137
+ import "./get_loyalty_stores_corporation_id_offers_ok.d.ts";
138
+ import "./get_alliances_alliance_id_contacts_labels_ok.d.ts";
139
+ import "./post_characters_character_id_assets_names_ok.d.ts";
140
+ import "./get_characters_character_id_industry_jobs_ok.d.ts";
141
+ import "./get_characters_character_id_notifications_ok.d.ts";
142
+ import "./get_characters_character_id_opportunities_ok.d.ts";
97
143
  import "./get_corporations_corporation_id_contracts_ok.d.ts";
98
- import "./get_corporations_corporation_id_contracts_contract_id_bids_ok.d.ts";
99
- import "./get_corporations_corporation_id_contracts_contract_id_items_ok.d.ts";
100
- import "./get_corporations_corporation_id_customs_offices_ok.d.ts";
101
144
  import "./get_corporations_corporation_id_divisions_ok.d.ts";
145
+ import "./get_corporations_corporation_id_standings_ok.d.ts";
146
+ import "./get_corporations_corporation_id_starbases_ok.d.ts";
147
+ import "./post_characters_character_id_contacts_created.d.ts";
148
+ import "./post_characters_character_id_fittings_created.d.ts";
149
+ import "./get_characters_character_id_loyalty_points_ok.d.ts";
150
+ import "./get_characters_character_id_orders_history_ok.d.ts";
151
+ import "./get_characters_character_id_wallet_journal_ok.d.ts";
152
+ import "./get_corporations_corporation_id_blueprints_ok.d.ts";
102
153
  import "./get_corporations_corporation_id_facilities_ok.d.ts";
103
- import "./get_corporations_corporation_id_fw_stats_ok.d.ts";
104
- import "./get_corporations_corporation_id_icons_ok.d.ts";
154
+ import "./get_corporations_corporation_id_structures_ok.d.ts";
155
+ import "./get_characters_character_id_agents_research_ok.d.ts";
156
+ import "./get_characters_character_id_contacts_labels_ok.d.ts";
157
+ import "./get_characters_character_id_killmails_recent_ok.d.ts";
158
+ import "./get_corporations_corporation_id_shareholders_ok.d.ts";
159
+ import "./get_universe_asteroid_belts_asteroid_belt_id_ok.d.ts";
160
+ import "./get_universe_constellations_constellation_id_ok.d.ts";
161
+ import "./post_characters_character_id_assets_locations_ok.d.ts";
162
+ import "./get_characters_character_id_calendar_event_id_ok.d.ts";
163
+ import "./post_characters_character_id_mail_labels_created.d.ts";
164
+ import "./get_characters_character_id_planets_planet_id_ok.d.ts";
165
+ import "./post_corporations_corporation_id_assets_names_ok.d.ts";
105
166
  import "./get_corporations_corporation_id_industry_jobs_ok.d.ts";
106
- import "./get_corporations_corporation_id_killmails_recent_ok.d.ts";
107
- import "./get_corporations_corporation_id_medals_ok.d.ts";
108
167
  import "./get_corporations_corporation_id_medals_issued_ok.d.ts";
109
- import "./get_corporations_corporation_id_members_ok.d.ts";
110
168
  import "./get_corporations_corporation_id_members_limit_ok.d.ts";
169
+ import "./get_corporations_corporation_id_roles_history_ok.d.ts";
170
+ import "./get_characters_character_id_corporationhistory_ok.d.ts";
111
171
  import "./get_corporations_corporation_id_members_titles_ok.d.ts";
112
172
  import "./get_corporations_corporation_id_membertracking_ok.d.ts";
113
- import "./get_corporations_corporation_id_orders_ok.d.ts";
114
173
  import "./get_corporations_corporation_id_orders_history_ok.d.ts";
115
- import "./get_corporations_corporation_id_roles_ok.d.ts";
116
- import "./get_corporations_corporation_id_roles_history_ok.d.ts";
117
- import "./get_corporations_corporation_id_shareholders_ok.d.ts";
118
- import "./get_corporations_corporation_id_standings_ok.d.ts";
119
- import "./get_corporations_corporation_id_starbases_ok.d.ts";
174
+ import "./post_fleets_fleet_id_wings_wing_id_squads_created.d.ts";
175
+ import "./get_characters_character_id_wallet_transactions_ok.d.ts";
176
+ import "./get_corporation_corporation_id_mining_observers_ok.d.ts";
177
+ import "./get_corporations_corporation_id_alliancehistory_ok.d.ts";
178
+ import "./get_corporations_corporation_id_contacts_labels_ok.d.ts";
179
+ import "./get_corporations_corporation_id_containers_logs_ok.d.ts";
180
+ import "./get_corporations_corporation_id_customs_offices_ok.d.ts";
181
+ import "./get_corporations_corporation_id_killmails_recent_ok.d.ts";
182
+ import "./get_corporation_corporation_id_mining_extractions_ok.d.ts";
183
+ import "./post_corporations_corporation_id_assets_locations_ok.d.ts";
184
+ import "./get_characters_character_id_notifications_contacts_ok.d.ts";
120
185
  import "./get_corporations_corporation_id_starbases_starbase_id_ok.d.ts";
121
- import "./get_corporations_corporation_id_structures_ok.d.ts";
122
- import "./get_corporations_corporation_id_titles_ok.d.ts";
123
- import "./get_corporations_corporation_id_wallets_ok.d.ts";
186
+ import "./get_characters_character_id_contracts_contract_id_bids_ok.d.ts";
187
+ import "./get_characters_character_id_calendar_event_id_attendees_ok.d.ts";
188
+ import "./get_characters_character_id_contracts_contract_id_items_ok.d.ts";
124
189
  import "./get_corporations_corporation_id_wallets_division_journal_ok.d.ts";
190
+ import "./get_corporations_corporation_id_contracts_contract_id_bids_ok.d.ts";
191
+ import "./get_corporation_corporation_id_mining_observers_observer_id_ok.d.ts";
192
+ import "./get_corporations_corporation_id_contracts_contract_id_items_ok.d.ts";
125
193
  import "./get_corporations_corporation_id_wallets_division_transactions_ok.d.ts";
126
- import "./get_dogma_attributes_ok.d.ts";
127
- import "./get_dogma_attributes_attribute_id_ok.d.ts";
128
- import "./get_dogma_dynamic_items_type_id_item_id_ok.d.ts";
129
- import "./get_dogma_effects_ok.d.ts";
130
- import "./get_dogma_effects_effect_id_ok.d.ts";
131
- import "./get_fleets_fleet_id_ok.d.ts";
132
- import "./get_fleets_fleet_id_members_ok.d.ts";
133
- import "./get_fleets_fleet_id_wings_ok.d.ts";
134
- import "./post_fleets_fleet_id_wings_created.d.ts";
135
- import "./post_fleets_fleet_id_wings_wing_id_squads_created.d.ts";
136
- import "./get_fw_leaderboards_ok.d.ts";
137
- import "./get_fw_leaderboards_characters_ok.d.ts";
138
- import "./get_fw_leaderboards_corporations_ok.d.ts";
139
- import "./get_fw_stats_ok.d.ts";
140
- import "./get_fw_systems_ok.d.ts";
141
- import "./get_fw_wars_ok.d.ts";
142
- import "./get_incursions_ok.d.ts";
143
- import "./get_industry_facilities_ok.d.ts";
144
- import "./get_industry_systems_ok.d.ts";
145
- import "./get_insurance_prices_ok.d.ts";
146
- import "./get_killmails_killmail_id_killmail_hash_ok.d.ts";
147
- import "./get_loyalty_stores_corporation_id_offers_ok.d.ts";
148
- import "./get_markets_groups_ok.d.ts";
149
- import "./get_markets_groups_market_group_id_ok.d.ts";
150
- import "./get_markets_prices_ok.d.ts";
151
- import "./get_markets_structures_structure_id_ok.d.ts";
152
- import "./get_markets_region_id_history_ok.d.ts";
153
- import "./get_markets_region_id_orders_ok.d.ts";
154
- import "./get_markets_region_id_types_ok.d.ts";
155
- import "./get_opportunities_groups_ok.d.ts";
156
- import "./get_opportunities_groups_group_id_ok.d.ts";
157
- import "./get_opportunities_tasks_ok.d.ts";
158
- import "./get_opportunities_tasks_task_id_ok.d.ts";
159
- import "./get_route_origin_destination_ok.d.ts";
160
- import "./get_sovereignty_campaigns_ok.d.ts";
161
- import "./get_sovereignty_map_ok.d.ts";
162
- import "./get_sovereignty_structures_ok.d.ts";
163
- import "./get_status_ok.d.ts";
164
- import "./get_universe_ancestries_ok.d.ts";
165
- import "./get_universe_asteroid_belts_asteroid_belt_id_ok.d.ts";
166
- import "./get_universe_bloodlines_ok.d.ts";
167
- import "./get_universe_categories_ok.d.ts";
168
- import "./get_universe_categories_category_id_ok.d.ts";
169
- import "./get_universe_constellations_ok.d.ts";
170
- import "./get_universe_constellations_constellation_id_ok.d.ts";
171
- import "./get_universe_factions_ok.d.ts";
172
- import "./get_universe_graphics_ok.d.ts";
173
- import "./get_universe_graphics_graphic_id_ok.d.ts";
174
- import "./get_universe_groups_ok.d.ts";
175
- import "./get_universe_groups_group_id_ok.d.ts";
176
- import "./post_universe_ids_ok.d.ts";
177
- import "./get_universe_moons_moon_id_ok.d.ts";
178
- import "./post_universe_names_ok.d.ts";
179
- import "./get_universe_planets_planet_id_ok.d.ts";
180
- import "./get_universe_races_ok.d.ts";
181
- import "./get_universe_regions_ok.d.ts";
182
- import "./get_universe_regions_region_id_ok.d.ts";
183
- import "./get_universe_schematics_schematic_id_ok.d.ts";
184
- import "./get_universe_stargates_stargate_id_ok.d.ts";
185
- import "./get_universe_stars_star_id_ok.d.ts";
186
- import "./get_universe_stations_station_id_ok.d.ts";
187
- import "./get_universe_structures_ok.d.ts";
188
- import "./get_universe_structures_structure_id_ok.d.ts";
189
- import "./get_universe_system_jumps_ok.d.ts";
190
- import "./get_universe_system_kills_ok.d.ts";
191
- import "./get_universe_systems_ok.d.ts";
192
- import "./get_universe_systems_system_id_ok.d.ts";
193
- import "./get_universe_types_ok.d.ts";
194
- import "./get_universe_types_type_id_ok.d.ts";
195
- import "./get_wars_ok.d.ts";
196
- import "./get_wars_war_id_ok.d.ts";
197
- import "./get_wars_war_id_killmails_ok.d.ts";
198
194
  import "./extra-types.d.ts";
199
195
 
200
196
 
@@ -203,6 +199,57 @@ import "./extra-types.d.ts";
203
199
  */
204
200
  type RequireThese<T, K extends keyof T> = T & Required<Pick<T, K>>;
205
201
 
202
+ /**
203
+ * Represents a function that can make ESI requests with various HTTP methods.
204
+ *
205
+ * @template ActualOpt - The actual type of the options.
206
+ *
207
+ * @example
208
+ * ```ts
209
+ * // @ ts-expect-error
210
+ * export const request: IESIRequestFunction<ESIRequestOptions> = (method, endpoint, pathParams, opt) => {
211
+ * // Implementation for "get" | "post" | "put" | "delete" request
212
+ * };
213
+ * // You can easily implement "get" | "post" | "put" | "delete" requests
214
+ * // with code like the following:
215
+ * (["get", "post", "put", "delete"] as (keyof typeof request)[]).forEach((method) => {
216
+ * request[method] = function (this: typeof request, endpoint, params, opt) {
217
+ * return this(method, endpoint, params, opt);
218
+ * } as TESIRequestFunctionEachMethod<typeof method>;
219
+ * });
220
+ * ```
221
+ */
222
+ export interface IESIRequestFunction<ActualOpt>
223
+ extends TESIRequestFunctionSignature<ActualOpt>, TESIRequestFunctionMethods<ActualOpt> {
224
+ }
225
+
226
+ /**
227
+ * Represents the methods available for making ESI requests.
228
+ *
229
+ * + This interface is used when you already have implementation code such as
230
+ * TESIRequestFunctionSignature and you want to implement additional shorthand methods.
231
+ *
232
+ * @template ActualOpt - The actual type of the options.
233
+ *
234
+ * @example
235
+ * ```ts
236
+ * export const request: TESIRequestFunctionSignature<ESIRequestOptions> = (method, endpoint, pathParams, opt) => {
237
+ * // Implementation for "get" | "post" | "put" | "delete" request
238
+ * };
239
+ * // You can easily implement "get" | "post" | "put" | "delete" requests
240
+ * // with code like the following:
241
+ * const esiMethods = {} as TESIRequestFunctionMethods<ESIRequestOptions>;
242
+ * (["get", "post", "put", "delete"] as (keyof TESIRequestFunctionMethods)[]).forEach((method) => {
243
+ * esiMethods[method] = function (endpoint, params, opt) {
244
+ * return request(method, endpoint, params, opt);
245
+ * } as TESIRequestFunctionEachMethod<typeof method>;
246
+ * });
247
+ * ```
248
+ */
249
+ export type TESIRequestFunctionMethods<ActualOpt = {}> = {
250
+ [method in TESIEntryMethod]: TESIRequestFunctionEachMethod<method, ActualOpt>;
251
+ }
252
+
206
253
  declare global {
207
254
 
208
255
  /**
@@ -224,15 +271,40 @@ declare global {
224
271
  type TESIRequestFunctionSignature<ActualOpt> = <
225
272
  M extends TESIEntryMethod,
226
273
  EP extends keyof TESIResponseOKMap[M],
227
- P2 extends IsParameterizedPath<EP, number | number[], Opt>,
274
+ P2 extends IfParameterizedPath<EP, Opt>,
228
275
  Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt>,
229
276
  R extends InferESIResponseResult<M, EP>
230
277
  >(method: M, endpoint: EP, pathParams?: P2, options?: Opt) => Promise<R>;
231
278
 
232
279
  /**
233
- * is parameterized path
280
+ * Represents a function that makes an ESI request using a specific HTTP method.
281
+ *
282
+ * @template M - The HTTP method to use for the request (e.g., "get", "post").
283
+ * @template ActualOpt - The actual type of the options to include in the request.
284
+ *
285
+ * @param endpoint - The path of the ESI endpoint to send the request to.
286
+ * @param pathParams - An optional parameter that can be a number, an array of numbers, or other parameters
287
+ * depending on whether the path is parameterized.
288
+ * @param options - An optional object containing additional options for the request.
289
+ *
290
+ * @returns A Promise object containing the response data, with the type inferred based on the method and endpoint.
291
+ */
292
+ type TESIRequestFunctionEachMethod<M extends TESIEntryMethod, ActualOpt = {}> = <
293
+ EP extends keyof TESIResponseOKMap[M],
294
+ P2 extends IfParameterizedPath<EP, Opt>,
295
+ Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ActualOpt>,
296
+ R extends InferESIResponseResult<M, EP>
297
+ >(endpoint: EP, pathParams?: P2, options?: Opt) => Promise<R>;
298
+
299
+ // /**
300
+ // * is parameterized path
301
+ // */
302
+ // type IsParameterizedPath<EP, A, B> = EP extends `${string}/{${string}}/${string | ""}` ? A: B;
303
+ /**
304
+ * if parameterized path then specify number type, otherwise will be `Opt` type.
234
305
  */
235
- type IsParameterizedPath<EP, A, B> = EP extends `${string}/{${string}}/${string | ""}` ? A: B;
306
+ type IfParameterizedPath<EP, Opt> = EP extends `${string}/{${string}}/${string | ""}` ? number | number[]: Opt;
307
+
236
308
  /**
237
309
  * Identifies the required parameters for a given entry type.
238
310
  *
@@ -368,16 +440,6 @@ export type TESIResponseOKMap = {
368
440
  /** `esi-characters.read_blueprints.v1` */
369
441
  auth: true;
370
442
  },
371
- "/characters/{character_id}/bookmarks/": {
372
- result: GetCharactersCharacterIdBookmarksOk;
373
- /** `esi-bookmarks.read_character_bookmarks.v1` */
374
- auth: true;
375
- },
376
- "/characters/{character_id}/bookmarks/folders/": {
377
- result: GetCharactersCharacterIdBookmarksFoldersOk;
378
- /** `esi-bookmarks.read_character_bookmarks.v1` */
379
- auth: true;
380
- },
381
443
  "/characters/{character_id}/calendar/": {
382
444
  result: GetCharactersCharacterIdCalendarOk;
383
445
  query: {
@@ -655,16 +717,6 @@ export type TESIResponseOKMap = {
655
717
  /** `esi-corporations.read_blueprints.v1` */
656
718
  auth: true;
657
719
  },
658
- "/corporations/{corporation_id}/bookmarks/": {
659
- result: GetCorporationsCorporationIdBookmarksOk;
660
- /** `esi-bookmarks.read_corporation_bookmarks.v1` */
661
- auth: true;
662
- },
663
- "/corporations/{corporation_id}/bookmarks/folders/": {
664
- result: GetCorporationsCorporationIdBookmarksFoldersOk;
665
- /** `esi-bookmarks.read_corporation_bookmarks.v1` */
666
- auth: true;
667
- },
668
720
  "/corporations/{corporation_id}/contacts/": {
669
721
  result: GetCorporationsCorporationIdContactsOk;
670
722
  /** `esi-corporations.read_contacts.v1` */
package/v2.d.mts CHANGED
@@ -11,7 +11,7 @@ import { type ESIRequestOptions } from "./rq-util.mjs";
11
11
  * fire ESI request
12
12
  * @template {TESIEntryMethod} M
13
13
  * @template {keyof TESIResponseOKMap[M]} EP
14
- * @template {IsParameterizedPath<EP, number | number[], Opt>} P2
14
+ * @template {IfParameterizedPath<EP, Opt>} P2
15
15
  * @template {IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>} Opt
16
16
  * @template {InferESIResponseResult<M, EP>} R
17
17
  *
@@ -23,10 +23,4 @@ import { type ESIRequestOptions } from "./rq-util.mjs";
23
23
  * @throws
24
24
  * @async
25
25
  */
26
- export declare function fire<
27
- M extends TESIEntryMethod,
28
- EP extends keyof TESIResponseOKMap[M],
29
- Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>,
30
- P2 extends IsParameterizedPath<EP, number | number[], Opt>,
31
- R extends InferESIResponseResult<M, EP>
32
- >(mthd: M, endp: EP, pathParams?: P2, opt?: Opt): Promise<R>;
26
+ export declare function fire<M extends TESIEntryMethod, EP extends keyof TESIResponseOKMap[M], P2 extends IfParameterizedPath<EP, Opt>, Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>, R extends InferESIResponseResult<M, EP>>(mthd: M, endp: EP, pathParams?: P2, opt?: Opt): Promise<R>;
package/v2.mjs CHANGED
@@ -29,7 +29,7 @@ const incrementAx = (minus) => minus ? ax-- : ax++;
29
29
  * fire ESI request
30
30
  * @template {TESIEntryMethod} M
31
31
  * @template {keyof TESIResponseOKMap[M]} EP
32
- * @template {IsParameterizedPath<EP, number | number[], Opt>} P2
32
+ * @template {IfParameterizedPath<EP, Opt>} P2
33
33
  * @template {IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>} Opt
34
34
  * @template {InferESIResponseResult<M, EP>} R
35
35
  *
@@ -43,11 +43,11 @@ const incrementAx = (minus) => minus ? ax-- : ax++;
43
43
  */
44
44
  export async function fire(mthd, endp, pathParams, opt) {
45
45
  if (typeof pathParams === "number") {
46
- // @ts-ignore
46
+ // @ts-expect-error
47
47
  pathParams = [pathParams]; // as unknown as P2;
48
48
  }
49
49
  if (isArray(pathParams)) {
50
- // @ts-ignore actualy endp is string
50
+ // @ts-expect-error actualy endp is string
51
51
  endp = replaceCbt(endp, pathParams);
52
52
  }
53
53
  // When only options are provided
@@ -55,13 +55,13 @@ export async function fire(mthd, endp, pathParams, opt) {
55
55
  // @ts-ignore
56
56
  const actualOpt = opt || pathParams || {};
57
57
  const { rqopt, qss } = initOptions(mthd, actualOpt);
58
- // @ts-ignore actualy endp is string
58
+ // @ts-expect-error actualy endp is string
59
59
  const endpointUrl = curl(endp);
60
- const url = `${endpointUrl}?${new URLSearchParams(qss) + ""}`;
60
+ const up = new URLSearchParams(qss);
61
+ const url = `${endpointUrl}${up.size ? `?${up}` : ""}`;
61
62
  LOG && log(url);
62
63
  ax++;
63
64
  try {
64
- // @ts-ignore A silly type error will appear, but ignore it.
65
65
  const res = await fetch(url, rqopt).finally(() => ax--);
66
66
  const { status } = res;
67
67
  if (!res.ok && !actualOpt.ignoreError) {
@@ -88,19 +88,19 @@ export async function fire(mthd, endp, pathParams, opt) {
88
88
  }
89
89
  // - - - - x-pages response.
90
90
  // +undefined is NaN
91
- // @ts-ignore becouse +null is 0
91
+ // @ts-expect-error becouse +null is 0
92
92
  const pc = +res.headers.get("x-pages");
93
93
  // has remaining pages? NaN > 1 === false !isNaN(pageCount)
94
94
  if (pc > 1) {
95
95
  LOG && log('found "x-pages" header, pages: %d', pc);
96
- const remData = await fetchP(endpointUrl, rqopt, qss, pc, incrementAx);
96
+ const remData = await fetchP(endpointUrl, rqopt, up, pc, incrementAx);
97
97
  // finally, decide product data.
98
98
  if (isArray(data) && isArray(remData)) {
99
99
  // DEVNOTE: 2019/7/23 15:01:48 - types
100
100
  return /** @type {R} */ (data.concat(remData));
101
101
  }
102
102
  else {
103
- // @ts-ignore TODO: fix type
103
+ // @ts-expect-error TODO: fix type
104
104
  remData && Object.assign(data, remData);
105
105
  }
106
106
  }
@@ -108,7 +108,7 @@ export async function fire(mthd, endp, pathParams, opt) {
108
108
  }
109
109
  }
110
110
  catch (e) {
111
- // @ts-ignore actualy endp is string
111
+ // @ts-expect-error actualy endp is string
112
112
  throw new ESIRequesError(`message: ${e.message}, endpoint=${endp}`);
113
113
  }
114
114
  }
@@ -123,7 +123,6 @@ async function getEVEStatus(fn) {
123
123
  return fn("get", "/status/");
124
124
  }
125
125
  // type following and run
126
- // bun scripts/v2.mts
127
126
  // node v2.mjs
128
127
  // or yarn test
129
128
  getEVEStatus(fire).then(eveStatus => console.log(eveStatus));
@@ -1,24 +0,0 @@
1
- /*!
2
- * ESI endpoint: get:/characters/{character_id}/bookmarks/folders/
3
- */
4
- /**
5
- * 200 ok array
6
- *
7
- * @maxItems 1000
8
- */
9
- type GetCharactersCharacterIdBookmarksFoldersOk = GetCharactersCharacterIdBookmarksFolders_200Ok[];
10
-
11
- /**
12
- * 200 ok object
13
- */
14
- interface GetCharactersCharacterIdBookmarksFolders_200Ok {
15
- /**
16
- * folder_id integer
17
- */
18
- folder_id: number;
19
- /**
20
- * name string
21
- */
22
- name: string;
23
- [k: string]: unknown | undefined;
24
- }