eve-esi-types 3.1.6 → 3.2.0

package/CHANGELOG.md

@@ -0,0 +1,182 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [3.2.0] - 2025-4-17
+
+### Added
+- New experimental utility type `InferNextEndpoint` (beta).
+
+### Changed
+- Until now, DTS files were written for each method and endpoint,  
+  but from this version, DTS files are written collectively by "tag".
+
+### Maintenance
+- Confirmed removal of the unused "opportunities" ESI endpoint, as per official deprecation notice.
+
+
+### ⚙️ Miscellaneous Tasks
+
+- Update keywords
+- Required flags (jsconfig.json)
+
+## [3.1.7] - 2025-04-05
+
+### 🐛 Bug Fixes
+
+- Update broken documentation link
+
+## [3.1.6] - 2025-04-05
+
+### 📚 Documentation
+
+- Add Markdown documentation link
+
+## [3.1.5] - 2025-04-04
+
+### ⚙️ Miscellaneous Tasks
+
+- Added utility type documentation (markdown)
+
+## [3.1.4] - 2025-04-04
+
+### 🚀 Features
+
+- Added new type `TESIEnhancedRequestFunctionSignature`
+
+### 🐛 Bug Fixes
+
+- `RestrictKeys`, `RequireThese`
+
+### 🚜 Refactor
+
+- *(types)* Add constraint to `TESIRequestFunctionSignature2` to ensure `ActualOpt` extends `Record<string, unknown>`
+- `IdentifyParameters`
+
+### ⚙️ Miscellaneous Tasks
+
+- Lint
+
+## [3.1.3] - 2025-03-24
+
+### 🐛 Bug Fixes
+
+- Ensure intended behavior by deliberately triggering semantic error
+
+## [3.1.2] - 2025-03-17
+
+### 💼 Other
+
+- Update README.md and add docs/esi-tagged-types.md
+
+## [3.1.1] - 2025-03-17
+
+### 🐛 Bug Fixes
+
+- Incomplete `TaggedEndpointRequestFunction2` type
+
+## [3.1.0] - 2025-03-17
+
+### 💼 Other
+
+- Significant enhancements to the main utility type for improved functionality
+
+### ⚙️ Miscellaneous Tasks
+
+- Update README.md, esi-types-util3.md
+- Update to version 3.1
+
+## [3.0.4] - 2025-03-14
+
+### ⚙️ Miscellaneous Tasks
+
+- Explain `TESIRequestFunctionSignature2` rest parameter `options` behavior
+
+## [3.0.3] - 2025-03-14
+
+### 🚜 Refactor
+
+- Enable determination of whether `Opt` is required or optional using the `HasOpt` generics parameter
+
+## [3.0.2] - 2025-03-14
+
+### 🚜 Refactor
+
+- Apply minItems and maxItems restrictions
+
+## [3.0.1] - 2025-03-13
+
+### ⚙️ Miscellaneous Tasks
+
+- About `decoreateESIRequestBody`
+
+## [3.0.0] - 2025-03-13
+
+### 🚀 Features
+
+- Update README for v3.0.0 new features
+
+## [2.3.5] - 2025-03-10
+
+### 🚀 Features
+
+- Added `cachedSeconds` member from "x-cached-seconds", new utility type `TESICachedSeconds`
+
+### 🐛 Bug Fixes
+
+- Typo ESIRequesError -> ESIRequestError
+
+### 🚜 Refactor
+
+- Enum to type, `EInferSomethingBy`
+
+## [2.3.4] - 2025-03-10
+
+### 🐛 Bug Fixes
+
+- Logger problem
+
+### 🚜 Refactor
+
+- Add lib/constants.mjs
+
+### ⚙️ Miscellaneous Tasks
+
+- Jsdoc of `initOptions`, refactor `injectESIRequestBody`
+- ESITagsWithMethodList -> ESITagMethodMapping
+- Apply `Object.freeze` to result of `injectESIRequestBody`
+- *(release)* V2.3.4 release
+
+## [2.3.3] - 2025-03-05
+
+### ⚙️ Miscellaneous Tasks
+
+- Add support for web browsers
+- Add comment regarding the importance of setting the language parameter
+- Add "index.html" for web testing
+
+## [2.3.2] - 2025-03-04
+
+### 🚜 Refactor
+
+- Introduce ESI Error handling via "lib/esi-error-types.d.ts"
+
+## [2.3.1] - 2025-03-02
+
+### 💼 Other
+
+- Added "v2/esi-tagged-types.d.ts" to define ESI tagged request types
+- Fix missing pragma "/// <reference types='../v2/esi-tagged-types'/>"
+
+### 🚜 Refactor
+
+- Small improvements
+- Utility type - v2/esi-tagged-types.d.ts
+- `IfParameterizedPath` improved
+
+## [2.2.5] - 2025-02-12
+
+### ⚙️ Miscellaneous Tasks
+
+- Remove non-functional bookmarks endpoints in ESI
+

package/jsconfig.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    // This flag is required
+    "skipLibCheck": true,
+    // This flag is required
+    "checkJs": true,
+    // This flag is required
+    "strict": true,
+    "noEmit": true,
+    // "skipDefaultLibCheck": true,
+    // "target": "esnext",
+    // "module": "esnext",
+    // "diagnostics": true,
+    // "moduleResolution": "node",
+    "rootDirs": [
+      "./"
+    ]
+  },
+  "include": [
+    "./*.mjs",
+    "./lib/*.mjs",
+    // "./lib/*.d.mts",
+    "./v2/**/*.d.ts"
+  ],
+  "exclude": [
+  ]
+}

package/lib/rq-util.mjs

@@ -276,7 +276,7 @@ export const fetchP = async (endpointUrl, rqopt, usp, pc, increment = () => { })
 export const replaceCbt = (endpoint, ids) => {
     let idx = 0;
     // @ts-expect-error
-    return endpoint.replace(/{([\w]+)}/g, $0 => ids[idx++] + "");
+    return endpoint.replace(/{([\w]+)}/g, () => ids[idx++] + "");
 };
 /**
  * @template {unknown} T

package/lib/tagged-request-api.mjs

@@ -28,12 +28,11 @@ const ESITagMethodMapping = [
     "Insurance:get", "Killmails:get",
     "Location:get", "Loyalty:get",
     "Mail:get,post,put,delete", "Market:get",
-    "Opportunities:get", "Planetary Interaction:get",
-    "Routes:get", "Search:get",
-    "Skills:get", "Sovereignty:get",
-    "Status:get", "Universe:get,post",
-    "User Interface:post", "Wallet:get",
-    "Wars:get"
+    "Planetary Interaction:get", "Routes:get",
+    "Search:get", "Skills:get",
+    "Sovereignty:get", "Status:get",
+    "Universe:get,post", "User Interface:post",
+    "Wallet:get", "Wars:get"
 ];
 /**
  * Decorates the ESI request body into a tagged ESI request map.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eve-esi-types",
-  "version": "3.1.6",
+  "version": "3.2.0",
   "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
   "main": "v2/index.d.ts",
   "scripts": {
@@ -15,22 +15,28 @@
     "v2",
     "lib",
     "web",
-    "docs",
     "*.d.mts",
     "*.mjs",
     "LICENSE",
     "*.md",
     "package.json",
-    "tsconfig.json"
+    "jsconfig.json"
   ],
   "keywords": [
-    "eve",
-    "esi",
-    "swagger",
-    "request",
     "api",
+    "esi",
+    "eve",
     "types",
-    "eve online"
+    "esi-api",
+    "eve-esi",
+    "swagger",
+    "api-types",
+    "eve online",
+    "eve-online",
+    "typescript",
+    "eve-swagger",
+    "swagger-types",
+    "typescript-definitions"
   ],
   "author": "jeffy-g",
   "license": "MIT",

package/v2/esi-tagged-types.d.ts

@@ -9,10 +9,10 @@
  * THIS DTS IS AUTO GENERATED, DO NOT EDIT
  * 
  * @file eve-esi-types/v2/esi-tagged-types.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 { TESIResponseOKMap } from "./index.d.ts";
-export * from "./index.d.ts";
+import type { TESIResponseOKMap } from "./index.d.ts";
+export type * from "./index.d.ts";
 
 /**
  * Converts a string to lower camel case.
@@ -49,7 +49,11 @@ declare type InferSomethingBy<Tag, AsType extends InferSomethingByBrand = InferS
  * @template M - The HTTP method.
  * @date 2025/2/28
  */
-export declare type ESITags = InferSomethingBy<never, InferSomethingByTags>
+export declare type ESITags = InferSomethingBy<never, InferSomethingByTags>;
+/**
+ * @date 2025/4/12
+ */
+export declare type LESITags = LCamelCase<ESITags>;
 
 // - - - - - - - - - - - - - - - - - - - - - - - - - -
 //            Utility Type `InferMethod`
@@ -60,7 +64,7 @@ export declare type ESITags = InferSomethingBy<never, InferSomethingByTags>
  * @template Tag - The tag to infer the method for.
  * @date 2025/2/28
  */
-export declare type InferMethod<Tag> = InferSomethingBy<Tag>
+export declare type InferMethod<Tag> = InferSomethingBy<Tag>;
 /* ctt
 type XAssets = InferMethod<"Assets">;
 type XContacts = InferMethod<"Contacts">;

package/v2/{get_alliances_alliance_id_ok.d.ts → globals/alliance.d.ts}

@@ -1,3 +1,18 @@
+// Generated by scripts/lib/code-synthesizer.mjs
+
+// - - - - - - - - - - - - - - - - - - - -
+//            @method {get}
+// - - - - - - - - - - - - - - - - - - - -
+/*!
+ * ESI endpoint: get:/alliances/
+ */
+/**
+ * 200 ok array
+ *
+ * @maxItems 5000
+ */
+type GetAlliancesOk = number[];
+
 /*!
  * ESI endpoint: get:/alliances/{alliance_id}/
  */
@@ -36,3 +51,32 @@ interface GetAlliancesAllianceIdOk {
   ticker: string;
   [k: string]: unknown | undefined;
 }
+
+/*!
+ * ESI endpoint: get:/alliances/{alliance_id}/corporations/
+ */
+/**
+ * 200 ok array
+ *
+ * @maxItems 1000
+ */
+type GetAlliancesAllianceIdCorporationsOk = number[];
+
+/*!
+ * ESI endpoint: get:/alliances/{alliance_id}/icons/
+ */
+
+/**
+ * 200 ok object
+ */
+interface GetAlliancesAllianceIdIconsOk {
+  /**
+   * px128x128 string
+   */
+  px128x128?: string;
+  /**
+   * px64x64 string
+   */
+  px64x64?: string;
+  [k: string]: unknown | undefined;
+}