eve-esi-types 2.1.2 → 2.2.1

package/v2/post_characters_affiliation_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/affiliation/
+ * ESI endpoint: post:/characters/affiliation/
  */
 /**
  * 200 ok array

package/v2/post_characters_character_id_assets_locations_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/assets/locations/
+ * ESI endpoint: post:/characters/{character_id}/assets/locations/
  */
 /**
  * 200 ok array

package/v2/post_characters_character_id_assets_names_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/assets/names/
+ * ESI endpoint: post:/characters/{character_id}/assets/names/
  */
 /**
  * 200 ok array

package/v2/post_characters_character_id_contacts_created.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/contacts/
+ * ESI endpoint: post:/characters/{character_id}/contacts/
  */
 /**
  * 201 created array

package/v2/post_characters_character_id_cspa_created.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/cspa/
+ * ESI endpoint: post:/characters/{character_id}/cspa/
  */
 /**
  * 201 created number

package/v2/post_characters_character_id_fittings_created.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/fittings/
+ * ESI endpoint: post:/characters/{character_id}/fittings/
  */
 
 /**

package/v2/post_characters_character_id_mail_created.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/mail/
+ * ESI endpoint: post:/characters/{character_id}/mail/
  */
 /**
  * Mail ID

package/v2/post_characters_character_id_mail_labels_created.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /characters/{character_id}/mail/labels/
+ * ESI endpoint: post:/characters/{character_id}/mail/labels/
  */
 /**
  * Label ID

package/v2/post_corporations_corporation_id_assets_locations_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /corporations/{corporation_id}/assets/locations/
+ * ESI endpoint: post:/corporations/{corporation_id}/assets/locations/
  */
 /**
  * 200 ok array

package/v2/post_corporations_corporation_id_assets_names_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /corporations/{corporation_id}/assets/names/
+ * ESI endpoint: post:/corporations/{corporation_id}/assets/names/
  */
 /**
  * 200 ok array

package/v2/post_fleets_fleet_id_wings_created.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /fleets/{fleet_id}/wings/
+ * ESI endpoint: post:/fleets/{fleet_id}/wings/
  */
 
 /**

package/v2/post_fleets_fleet_id_wings_wing_id_squads_created.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /fleets/{fleet_id}/wings/{wing_id}/squads/
+ * ESI endpoint: post:/fleets/{fleet_id}/wings/{wing_id}/squads/
  */
 
 /**

package/v2/post_universe_ids_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /universe/ids/
+ * ESI endpoint: post:/universe/ids/
  */
 
 /**

package/v2/post_universe_names_ok.d.ts

@@ -1,5 +1,5 @@
 /*!
- * ESI endpoint: /universe/names/
+ * ESI endpoint: post:/universe/names/
  */
 /**
  * category string

package/v2.d.mts

@@ -6,33 +6,7 @@
  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
 import type { TESIResponseOKMap } from "./v2";
-/**
- * __{Header}.{Payload}.{Signature}__
- */
-type TAcccessToken = `${string}.${string}.${string}`;
-type ESIRequestOptions = {
-    /**
-     * query params for ESI request.
-     */
-    query?: 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?: TAcccessToken;
-    auth?: true;
-};
+import { type ESIRequestOptions } from "./rq-util.mjs";
 /**
  * fire ESI request
  * @template {TESIEntryMethod} M

package/v2.mjs

@@ -1,4 +1,5 @@
 // import type { TESIResponseOKMap } from "eve-esi-types";
+import { curl, fetchP, replaceCbt, getSDEVersion, ESIRequesError, initOptions, isDebug, ESIErrorLimitReachedError, fireRequestsDoesNotRequireAuth } from "./rq-util.mjs";
 // - - - - - - - - - - - - - - - - - - - -
 //           constants, types
 // - - - - - - - - - - - - - - - - - - - -
@@ -8,23 +9,10 @@ const isArray = Array.isArray;
 /**
  * enable/disable console.log
  */
-let LOG = false;
-/**
- * this always `https://esi.evetech.net`
- */
-const BASE = "https://esi.evetech.net";
+let LOG = isDebug();
 /**
  * @typedef {import("./v2").TESIResponseOKMap} TESIResponseOKMap
- */
-/**
- * @typedef {`${string}.${string}.${string}`} TAcccessToken __{Header}.{Payload}.{Signature}__
- * @typedef ESIRequestOptions
- * @prop {Record<string, any>} [query] query params for ESI request.
- * @prop {any} [body] will need it for `POST` request etc.
- * @prop {true=} [auth] Can be an empty object if no authentication is required.description
- * @prop {string} [token] Can be an empty object if no authentication is required.description
- * @prop {boolean} [ignoreError]  if want response data with ignore error then can be set to `true`.
- * @prop {AbortController} [cancelable] cancel request immediately
+ * @typedef {import("./rq-util.mjs").ESIRequestOptions} ESIRequestOptions
  */
 // - - - - - - - - - - - - - - - - - - - -
 //        module vars, functions
@@ -33,124 +21,10 @@ const BASE = "https://esi.evetech.net";
  * Get the number of currently executing ESI requests
  */
 let ax = 0;
-/**
- * simple named error class.
- */
-class ESIRequesError extends Error {
-}
-/**
- * throws when x-esi-error-limit-remain header value is "0". (http status: 420)
- */
-class ESIErrorLimitReachedError extends Error {
-    constructor() {
-        super("Cannot continue ESI request because 'x-esi-error-limit-remain' is zero!");
-    }
-    valueOf() {
-        return 420;
-    }
-}
-/**
- * fetch the extra pages
- *
- *   + if the `x-pages` header property ware more than 1
- *
- * @param {string} endpointUrl
- * @param {RequestInit} rqopt request options
- * @param {Record<string, any>} qs queries
- * @param {number} pc pageCount
- */
-const fetchP = async (endpointUrl, rqopt, qs, pc) => {
-    const rqs = [];
-    const rqp = new URLSearchParams(qs);
-    for (let i = 2; i <= pc;) {
-        rqp.set("page", (i++) + "");
-        ax++;
-        rqs.push(fetch(`${endpointUrl}?${rqp + ""}`, rqopt).then(res => res.json()).catch(reason => {
-            console.warn(reason);
-            return [];
-        }).finally(() => {
-            ax--;
-        }));
-    }
-    return Promise.all(rqs).then(jsons => {
-        // DEVNOTE: let check the page 2, type is array?
-        if (isArray(jsons[0])) {
-            let combined = [];
-            for (let i = 0, end = jsons.length; i < end;) {
-                combined = combined.concat(jsons[i++]);
-            }
-            return combined;
-        }
-        LOG && log("> > > pages result are object < < < --", jsons);
-        return null;
-    });
-};
-/** ### replace (C)urly (B)races (T)oken
- *
- * @example
- * "/characters/{character_id}/skills"
- * // ->
- * "/characters/<char.character_id>/skills"
- *
- * @param {string} endpoint e.g - "/characters/{character_id}/"
- * @param {number[]} ids
- * @returns fragment of qualified endpoint uri or null.
- */
-const replaceCbt = (endpoint, ids) => {
-    const re = /{([\w]+)}/g;
-    /** @type {RegExpExecArray?} */
-    let m;
-    let idx = 0;
-    while (m = re.exec(endpoint)) {
-        endpoint = endpoint.replace(m[0], ids[idx++] + "");
-    }
-    return endpoint;
-};
-/**
- *
- * @param {string} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
- *   + The version parameter can be omitted by using `<version>/<endpoint>`
- */
-const curl = (endp) => {
-    endp = endp.replace(/^\/+|\/+$/g, "");
-    return `${BASE}/latest/${endp}/`;
-};
+const incrementAx = (minus) => minus ? ax-- : ax++;
 // - - - - - - - - - - - - - - - - - - - -
 //            main functions
 // - - - - - - - - - - - - - - - - - - - -
-// It should complete correctly.
-async function getEVEStatus() {
-    try {
-        const ok = await fire("get", "/characters/{character_id}/ship/", 994562, { auth: true });
-        // query patameter `filter` is optional
-        await fire("get", "/universe/structures/", {
-            query: {
-            // filter: "market"
-            }
-        });
-        // in this case, "categories" and "search" is required
-        await fire("get", "/characters/{character_id}/search/", 994562, {
-            query: {
-                categories: ["agent"],
-                search: "ok"
-            },
-            auth: true
-        });
-        // in this case, "order_type" is required
-        await fire("get", "/markets/{region_id}/orders/", 994562, {
-            query: {
-                order_type: "all"
-            },
-        });
-        // TODO: want TypeScript semantics to throw an error because there is a required query parameter, but it's not possible
-        await fire("get", "/characters/{character_id}/search/");
-        console.log(ok);
-    }
-    catch (error) {
-        console.error("Failed to get character ship -", error);
-    }
-    return fire("get", "/status/");
-}
 /**
  * fire ESI request
  * @template {TESIEntryMethod} M
@@ -179,63 +53,32 @@ export async function fire(mthd, endp, pathParams, opt) {
     // When only options are provided
     /** @type {Opt} */
     // @ts-ignore
-    const actualOpt = pathParams || opt || {};
-    /** @type {RequestInit} */
-    const rqopt = {
-        method: mthd,
-        mode: "cors",
-        cache: "no-cache",
-        // @ts-ignore 
-        signal: actualOpt.cancelable?.signal,
-        headers: {}
-    };
-    const qss = {
-        language: "en",
-    };
-    if (actualOpt.query) {
-        // Object.assign(queries, options.queries); Object.assign is too slow
-        const oqs = actualOpt.query;
-        for (const k of Object.keys(oqs)) {
-            qss[k] = oqs[k];
-        }
-    }
-    // DEVNOTE: when datasource is not empty string. (e.g - "singularity"
-    // in this case must specify datasource.
-    // disabled since `REMOVING DATASOURCE SINGULARITY`
-    // if (actualOpt.datasource === "singularity") {
-    //     actualOpt.datasource = "tranquility";
-    // }
-    if (actualOpt.auth) {
-        // @ts-ignore The header is indeed an object
-        rqopt.headers.authorization = `Bearer ${actualOpt.token}`;
-    }
-    if (actualOpt.body) { // means "POST" method etc
-        // @ts-ignore The header is indeed an object
-        rqopt.headers["content-type"] = "application/json";
-        rqopt.body = JSON.stringify(actualOpt.body);
-    }
+    const actualOpt = opt || pathParams || {};
+    const { rqopt, qss } = initOptions(mthd, actualOpt);
     // @ts-ignore actualy endp is string
     const endpointUrl = curl(endp);
+    const url = `${endpointUrl}?${new URLSearchParams(qss) + ""}`;
+    LOG && log(url);
     ax++;
     try {
         // @ts-ignore A silly type error will appear, but ignore it.
-        const res = await fetch(`${endpointUrl}?${new URLSearchParams(qss) + ""}`, rqopt).finally(() => ax--);
-        const stat = res.status;
+        const res = await fetch(url, rqopt).finally(() => ax--);
+        const { status } = res;
         if (!res.ok && !actualOpt.ignoreError) {
-            if (stat === 420) {
+            if (status === 420) {
                 actualOpt.cancelable && actualOpt.cancelable.abort();
                 throw new ESIErrorLimitReachedError();
             }
             else {
                 // console.log(res);
-                throw new ESIRequesError(`${res.statusText} (status=${stat})`);
+                throw new ESIRequesError(`${res.statusText} (status=${status})`);
             }
         }
         else {
             // DEVNOTE: - 204 No Content
-            if (stat === 204) {
+            if (status === 204) {
                 // this result is empty, decided to return status code.
-                return /** @type {R} */ ({ status: stat });
+                return /** @type {R} */ ({ status });
             }
             /** @type {R} */
             const data = await res.json();
@@ -250,7 +93,7 @@ export async function fire(mthd, endp, pathParams, opt) {
             // has remaining pages? NaN > 1 === false !isNaN(pageCount)
             if (pc > 1) {
                 LOG && log('found "x-pages" header, pages: %d', pc);
-                const remData = await fetchP(endpointUrl, rqopt, qss, pc);
+                const remData = await fetchP(endpointUrl, rqopt, qss, pc, incrementAx);
                 // finally, decide product data.
                 if (isArray(data) && isArray(remData)) {
                     // DEVNOTE: 2019/7/23 15:01:48 - types
@@ -269,10 +112,21 @@ export async function fire(mthd, endp, pathParams, opt) {
         throw new ESIRequesError(`message: ${e.message}, endpoint=${endp}`);
     }
 }
+// It should complete correctly.
+/**
+ * @param {TESIRequestFunctionSignature<ESIRequestOptions>} fn
+ */
+async function getEVEStatus(fn) {
+    const sdeVersion = await getSDEVersion();
+    log(`sdeVersion: ${sdeVersion}`.blue);
+    await fireRequestsDoesNotRequireAuth(fn);
+    return fn("get", "/status/");
+}
 // type following and run
+// bun scripts/v2.mts
 // node v2.mjs
-// or yarn test:v2
-getEVEStatus().then(eveStatus => console.log(eveStatus));
+// or yarn test
+getEVEStatus(fire).then(eveStatus => console.log(eveStatus));
 // {
 //     "players": 16503,
 //     "server_version": "2794925",

package/v2/post_fleets_fleet_id_members_invitation.d.ts

@@ -1,27 +0,0 @@
-/*!
- * ESI endpoint: /fleets/{fleet_id}/members/
- */
-/**
- * If a character is invited with the `fleet_commander` role, neither `wing_id` or `squad_id` should be specified. If a character is invited with the `wing_commander` role, only `wing_id` should be specified. If a character is invited with the `squad_commander` role, both `wing_id` and `squad_id` should be specified. If a character is invited with the `squad_member` role, `wing_id` and `squad_id` should either both be specified or not specified at all. If they aren’t specified, the invited character will join any squad with available positions.
- */
-type PostFleetsFleetIdMembersRole = "fleet_commander" | "wing_commander" | "squad_commander" | "squad_member";
-
-/**
- * invitation object
- */
-interface PostFleetsFleetIdMembersInvitation {
-  /**
-   * The character you want to invite
-   */
-  character_id: number;
-  role: PostFleetsFleetIdMembersRole;
-  /**
-   * squad_id integer
-   */
-  squad_id?: number;
-  /**
-   * wing_id integer
-   */
-  wing_id?: number;
-  [k: string]: unknown | undefined;
-}

package/v2/post_ui_openwindow_newmail_new_mail.d.ts

@@ -1,40 +0,0 @@
-/*!
- * ESI endpoint: /ui/openwindow/newmail/
- */
-/**
- * recipients array
- *
- * @minItems 1
- * @maxItems 50
- */
-type PostUiOpenwindowNewmailRecipients = [
-  /**
-   * recipient integer
-   */
-  number,
-  ...number[]
-];
-
-/**
- * new_mail object
- */
-interface PostUiOpenwindowNewmailNewMail {
-  /**
-   * body string
-   */
-  body: string;
-  recipients: PostUiOpenwindowNewmailRecipients;
-  /**
-   * subject string
-   */
-  subject: string;
-  /**
-   * to_corp_or_alliance_id integer
-   */
-  to_corp_or_alliance_id?: number;
-  /**
-   * Corporations, alliances and mailing lists are all types of mailing groups. You may only send to one mailing group, at a time, so you may fill out either this field or the to_corp_or_alliance_ids field
-   */
-  to_mailing_list_id?: number;
-  [k: string]: unknown | undefined;
-}

package/v2/put_characters_character_id_calendar_event_id_response.d.ts

@@ -1,15 +0,0 @@
-/*!
- * ESI endpoint: /characters/{character_id}/calendar/{event_id}/
- */
-/**
- * response string
- */
-type PutCharactersCharacterIdCalendarEventIdResponseResponse = "accepted" | "declined" | "tentative";
-
-/**
- * response object
- */
-interface PutCharactersCharacterIdCalendarEventIdResponse {
-  response: PutCharactersCharacterIdCalendarEventIdResponseResponse;
-  [k: string]: unknown | undefined;
-}

package/v2/put_characters_character_id_contacts_contact_ids.d.ts

@@ -1,16 +0,0 @@
-/*!
- * ESI endpoint: /characters/{character_id}/contacts/
- */
-/**
- * contact_ids array
- *
- * @minItems 1
- * @maxItems 100
- */
-type PutCharactersCharacterIdContactsContactIds = [
-  /**
-   * ID of the contact to edit
-   */
-  number,
-  ...number[]
-];

package/v2/put_characters_character_id_mail_mail_id_contents.d.ts

@@ -1,20 +0,0 @@
-/*!
- * ESI endpoint: /characters/{character_id}/mail/{mail_id}/
- */
-
-/**
- * contents object
- */
-interface PutCharactersCharacterIdMailMailIdContents {
-  /**
-   * Labels to assign to the mail. Pre-existing labels are unassigned.
-   *
-   * @maxItems 25
-   */
-  labels?: number[];
-  /**
-   * Whether the mail is flagged as read
-   */
-  read?: boolean;
-  [k: string]: unknown | undefined;
-}

package/v2/put_fleets_fleet_id_members_member_id_movement.d.ts

@@ -1,27 +0,0 @@
-/*!
- * ESI endpoint: /fleets/{fleet_id}/members/{member_id}/
- */
-/**
- * If a character is moved to the `fleet_commander` role, neither `wing_id` or `squad_id` should be specified. If a character is moved to the `wing_commander` role, only `wing_id` should be specified. If a character is moved to the `squad_commander` role, both `wing_id` and `squad_id` should be specified. If a character is moved to the `squad_member` role, both `wing_id` and `squad_id` should be specified.
- */
-type PutFleetsFleetIdMembersMemberIdRole =
-  | "fleet_commander"
-  | "wing_commander"
-  | "squad_commander"
-  | "squad_member";
-
-/**
- * movement object
- */
-interface PutFleetsFleetIdMembersMemberIdMovement {
-  role: PutFleetsFleetIdMembersMemberIdRole;
-  /**
-   * squad_id integer
-   */
-  squad_id?: number;
-  /**
-   * wing_id integer
-   */
-  wing_id?: number;
-  [k: string]: unknown | undefined;
-}

package/v2/put_fleets_fleet_id_new_settings.d.ts

@@ -1,18 +0,0 @@
-/*!
- * ESI endpoint: /fleets/{fleet_id}/
- */
-
-/**
- * new_settings object
- */
-interface PutFleetsFleetIdNewSettings {
-  /**
-   * Should free-move be enabled in the fleet
-   */
-  is_free_move?: boolean;
-  /**
-   * New fleet MOTD in CCP flavoured HTML
-   */
-  motd?: string;
-  [k: string]: unknown | undefined;
-}

package/v2/put_fleets_fleet_id_squads_squad_id_naming.d.ts

@@ -1,14 +0,0 @@
-/*!
- * ESI endpoint: /fleets/{fleet_id}/squads/{squad_id}/
- */
-
-/**
- * naming object
- */
-interface PutFleetsFleetIdSquadsSquadIdNaming {
-  /**
-   * name string
-   */
-  name: string;
-  [k: string]: unknown | undefined;
-}

package/v2/put_fleets_fleet_id_wings_wing_id_naming.d.ts

@@ -1,14 +0,0 @@
-/*!
- * ESI endpoint: /fleets/{fleet_id}/wings/{wing_id}/
- */
-
-/**
- * naming object
- */
-interface PutFleetsFleetIdWingsWingIdNaming {
-  /**
-   * name string
-   */
-  name: string;
-  [k: string]: unknown | undefined;
-}