npm - eve-esi-types - Versions diffs - 2.3.2 → 2.3.3 - Mend

eve-esi-types 2.3.2 → 2.3.3

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.

Files changed (7) hide show

package/index.html ADDED Viewed

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>eve-esi-types ESI request test</title>
+    <script type="module" src="./minimal-rq.mjs"></script>
+</head>
+<body>
+    <div class="container">
+    </div>
+    <div class="info">
+      browser-sync start -s --port 8080 --no-open --ss ./<br>
+      then access to <a href="http://localhost:8080/?x=1&debug=1">eve-esi-types ESI request test</a>
+    </div>
+    <footer class="footer"></footer>
+</body>
+</html>

package/lib/request-api.mjs CHANGED Viewed

@@ -43,22 +43,19 @@ export const request = async (method, endpoint, pathParams, opt) => {
         pathParams = [pathParams];
     }
     if (Array.isArray(pathParams)) {
-        // @ts-expect-error actualy endp is string
         endpoint = util.replaceCbt(endpoint, pathParams);
     }
     // When only options are provided
     const actualOpt = /** @type {NonNullable<typeof opt>} */ (opt || pathParams || {});
     const { rqopt, qss } = util.initOptions(method, actualOpt);
-    // @ts-expect-error actualy endp is string
     const endpointUrl = util.curl(endpoint);
     const up = new URLSearchParams(qss);
     const url = `${endpointUrl}${up.size ? `?${up}` : ""}`;
     DEBUG && log(url);
     try {
         const res = await fetch(url, rqopt);
-        const { status } = res;
         // The parameters are different for successful and error responses.
-        if (util.isSuccess(status)) {
+        if (util.isSuccess(res.status)) {
             return util.handleSuccessResponse(res, endpointUrl, rqopt, up);
         }
         // else if (isError(status)) {}

package/lib/rq-util.d.mts CHANGED Viewed

@@ -5,9 +5,22 @@
 //  https://opensource.org/licenses/mit-license.php
 // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 */
-import "colors.ts";
+/// <reference types="../v2"/>
+// - - - - - - - - - - - - - - - - - - - -
+//               imports
+// - - - - - - - - - - - - - - - - - - - -
 import type { TESIRequestFunctionMethods } from "../v2";
 import type { TESIErrorStats } from "./esi-error-types";
+/**
+ * Dummy import
+ * @import * as cc from "colors.ts";
+ */
+/**
+ * will almost certainly be able to detect if you are in a nodejs environment
+ *
+ * @date 2020/5/9
+ */
+export declare const isNode: boolean;
 /**
  * this always `https://esi.evetech.net`
  */
@@ -138,18 +151,20 @@ export declare const fetchP: <T extends unknown>(endpointUrl: string, rqopt: Req
  * // ->
  * "/characters/<char.character_id>/skills"
  *
- * @param {string} endpoint e.g - "/characters/{character_id}/"
+ * @template {unknown} T
+ * @param {T} endpoint e.g - "/characters/{character_id}/"
  * @param {number[]} ids
- * @returns {string | null} fragment of qualified endpoint uri or null.
+ * @returns {T} fragment of qualified endpoint uri or null.
  */
-export declare const replaceCbt: (endpoint: string, ids: number[]) => string;
+export declare const replaceCbt: <T extends unknown>(endpoint: T, ids: number[]) => T;
 /**
  *
- * @param {string} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
+ * @template {unknown} T
+ * @param {T} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
  *   + The version parameter is forced to apply `latest`
  * @returns {string}
  */
-export declare const curl: (endp: string) => string;
+export declare const curl: <T extends unknown>(endp: T) => string;
 /**
  * @date 2020/03/31
  * @version 2.1

package/lib/rq-util.mjs CHANGED Viewed

@@ -9,7 +9,29 @@
 // - - - - - - - - - - - - - - - - - - - -
 //               imports
 // - - - - - - - - - - - - - - - - - - - -
-import "colors.ts";
+/**
+ * Dummy import
+ * @import * as cc from "colors.ts";
+ */
+/**
+ * will almost certainly be able to detect if you are in a nodejs environment
+ *
+ * @date 2020/5/9
+ */
+export const isNode = await (async () => {
+    let modId, returnValue;
+    if (typeof process === "object") {
+        modId = "colors.ts";
+        // @ts-ignore
+        returnValue = typeof process.versions === "object" && /\d+\.\d+\.\d+/.test(process.versions.node);
+    }
+    else {
+        modId = "https://cdn.jsdelivr.net/npm/colors.ts@1.0.20/+esm";
+        returnValue = false;
+    }
+    await import(modId);
+    return returnValue;
+})();
 // - - - - - - - - - - - - - - - - - - - -
 //           constants, types
 // - - - - - - - - - - - - - - - - - - - -
@@ -153,13 +175,36 @@ export const isError = (stat) => {
  * @returns {boolean}
  */
 export const isDebug = () => {
-    return process.argv.includes("-debug");
+    return is("debug");
 };
 /**
  * @param {string} opt
  * @returns {boolean}
  */
-export const is = (opt) => process.argv.includes(`-${opt}`);
+export const is = (opt) => {
+    if (typeof process === "object") {
+        return process.argv.includes(`-${opt}`);
+    }
+    else {
+        const q = location.search || location.hash;
+        if (q) {
+            //* ctt
+            const entries = q.substring(1).split("&");
+            for (const entry of entries) {
+                const [key, /*value*/] = entry.split("=");
+                if (key === opt)
+                    return true;
+            }
+            /*/
+            const usp = new URLSearchParams(q.substring(1));
+            for (const [key, value] of usp.entries()) {
+                if (key === opt) return true;
+            }
+            //*/
+        }
+    }
+    return false;
+};
 /**
  * @param {string} method
  * @param {ESIRequestOptions} opt
@@ -176,7 +221,9 @@ export const initOptions = (method, opt) => {
     };
     /** @type {Record<string, string>} */
     const qss = {
-    // language: "en",
+        // CAVEAT: If the language parameter is not set, some endpoints such as "/universe/ids/" may return incomplete results.
+        // Therefore, the language parameter should always be set.
+        language: "en",
     };
     if (opt.query) {
         // Object.assign(query, options.query); Object.assign is too slow
@@ -238,23 +285,26 @@ export const fetchP = async (endpointUrl, rqopt, rqp, pc, increment = () => { })
  * // ->
  * "/characters/<char.character_id>/skills"
  *
- * @param {string} endpoint e.g - "/characters/{character_id}/"
+ * @template {unknown} T
+ * @param {T} endpoint e.g - "/characters/{character_id}/"
  * @param {number[]} ids
- * @returns {string | null} fragment of qualified endpoint uri or null.
+ * @returns {T} fragment of qualified endpoint uri or null.
  */
 export const replaceCbt = (endpoint, ids) => {
     let idx = 0;
+    // @ts-expect-error
     return endpoint.replace(/{([\w]+)}/g, $0 => ids[idx++] + "");
 };
 /**
  *
- * @param {string} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
+ * @template {unknown} T
+ * @param {T} endp this means endpoint url fragment like `/characters/{character_id}/` or `/characters/{character_id}/agents_research/`
  *   + The version parameter is forced to apply `latest`
  * @returns {string}
  */
 export const curl = (endp) => {
-    endp = endp.replace(/^\/+|\/+$/g, "");
-    return `${BASE}/latest/${endp}/`;
+    // @ts-expect-error
+    return `${BASE}/latest/${endp.replace(/^\/+|\/+$/g, "")}/`;
 };
 /**
  * @date 2020/03/31

package/minimal-rq.mjs CHANGED Viewed

@@ -83,6 +83,12 @@ async function getEVEStatus(fn) {
 if (!util.is("x")) {
     getEVEStatus(request).then(eveStatus => log(eveStatus));
 }
+else {
+    // @ts-ignore
+    globalThis.runTest = () => {
+        getEVEStatus(request).then(eveStatus => log(eveStatus));
+    };
+}
 // {
 //     "players": 16503,
 //     "server_version": "2794925",

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
   "main": "v2/index.d.ts",
   "scripts": {
@@ -15,6 +15,7 @@
     "v2",
     "lib",
     "*.d.mts",
+    "index.html",
     "*.mjs",
     "LICENSE",
     "*.md",

package/v2.mjs CHANGED Viewed

@@ -51,7 +51,6 @@ export async function fire(mthd, endp, pathParams, opt) {
         pathParams = [pathParams]; // as unknown as P2;
     }
     if (isArray(pathParams)) {
-        // @ts-expect-error actualy endp is string
         endp = replaceCbt(endp, pathParams);
     }
     // When only options are provided
@@ -59,7 +58,6 @@ export async function fire(mthd, endp, pathParams, opt) {
     // @ts-ignore
     const actualOpt = opt || pathParams || {};
     const { rqopt, qss } = initOptions(mthd, actualOpt);
-    // @ts-expect-error actualy endp is string
     const endpointUrl = curl(endp);
     const up = new URLSearchParams(qss);
     const url = `${endpointUrl}${up.size ? `?${up}` : ""}`;
@@ -67,9 +65,8 @@ export async function fire(mthd, endp, pathParams, opt) {
     ax++;
     try {
         const res = await fetch(url, rqopt).finally(() => ax--);
-        const { status } = res;
         // The parameters are different for successful and error responses.
-        if (isSuccess(status)) {
+        if (isSuccess(res.status)) {
             return handleSuccessResponse(res, endpointUrl, rqopt, up, incrementAx);
         }
         // else if (isError(status)) {}