eve-esi-types 2.0.5-beta → 2.1.2

package/README.md

@@ -3,10 +3,36 @@ Extracted the main type of ESI. Used for ESI request response types.
 
 ## Usage
 
-> Sample code is provided -> [`esi-request.mjs`](./esi-request.mjs)
+> This package is configured to use version 2 only.
 
+  + If you need to use version 1, please refer to the following link:  
+    [eve-esi-types v1](https://github.com/jeffy-g/eve-esi-types/tree/v1.1.0)
+
+
+> Sample code is provided -> [`v2.mjs`](./v2.mjs)
 
 ```shell
-$ node esi-request.mjs
+$ node v2.mjs
 ```
+## API
+
+> The following function signature allows you to benefit from `eve-esi-types`.  
+> By specifying the method (`get`, `post`, `put`, `delete`) for each `endpoint`,  
+> you can determine the result type of the ESI request, what query parameters are required,  
+> and whether OAuth authentication is necessary (`auth: true`).
+
+```ts
+// function signature
+export declare function fire<
+    M extends TESIEntryMethod,
+    EP extends keyof TESIResponseOKMap[M],
+    Opt extends IdentifyParameters<TESIResponseOKMap[M][EP], ESIRequestOptions>,
+    P2 extends IsParameterizedPath<EP, number | number[], Opt>,
+    R extends InferESIResponseResult<M, EP>
+>(mthd: M, endp: EP, pathParams?: P2, opt?: Opt): Promise<R>;
+```
+
+
+## References
 
+- [`ESI Types Utility Definitions`](./esi-types-util.md)

package/esi-types-util.md

@@ -0,0 +1,108 @@
+<!--!
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  Copyright (C) 2025 jeffy-g <hirotom1107@gmail.com>
+  Released under the MIT license
+  https://opensource.org/licenses/mit-license.php
+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+-->
+
+## ESI Types Utility Definitions
+
+### IsParameterizedPath
+
+`IsParameterizedPath<EP, A, B>` is a type to determine if a path is parameterized. If it is, it returns `A`, otherwise it returns `B`.
+
+```typescript
+type IsParameterizedPath<EP, A, B> = EP extends `${string}/{${string}}/${string | ""}` ? A : B;
+```
+
+### IdentifyParameters
+
+`IdentifyParameters<Entry, Opt>` is a type to identify the required parameters for a given entry type.
+
+```typescript
+type IdentifyParameters<Entry, Opt> = Opt & Pick<Entry, Exclude<keyof Entry, "result">>;
+```
+
+### InferESIResponseResult
+
+`InferESIResponseResult<M extends TESIEntryMethod, EP extends keyof TESIResponseOKMap[M]>` is a type to infer the result type of an ESI response based on the method and endpoint.
+
+```typescript
+type InferESIResponseResult<
+  M extends TESIEntryMethod,
+  EP extends keyof TESIResponseOKMap[M]
+> = TESIResponseOKMap[M][EP] extends { result: infer U } ? U : never;
+```
+
+### TESIEntryMethod
+
+`TESIEntryMethod` represents the HTTP methods supported by ESI.
+
+```typescript
+type TESIEntryMethod = keyof TESIResponseOKMap;
+```
+
+### TEndPointGet
+
+`TEndPointGet` represents the endpoints for the "get" method.
+
+```typescript
+type TEndPointGet = keyof TESIResponseOKMap["get"];
+```
+
+### TEndPointPost
+
+`TEndPointPost` represents the endpoints for the "post" method.
+
+```typescript
+type TEndPointPost = keyof TESIResponseOKMap["post"];
+```
+
+### TEndPointPut
+
+`TEndPointPut` represents the endpoints for the "put" method.
+
+```typescript
+type TEndPointPut = keyof TESIResponseOKMap["put"];
+```
+
+### TEndPointDelete
+
+`TEndPointDelete` represents the endpoints for the "delete" method.
+
+```typescript
+type TEndPointDelete = keyof TESIResponseOKMap["delete"];
+```
+
+### TESIResponseGetEntry
+
+`TESIResponseGetEntry<K extends TEndPointGet>` represents the entry details for the "get" method.
+
+```typescript
+type TESIResponseGetEntry<K extends TEndPointGet> = TESIResponseOKMap["get"][K];
+```
+
+### TESIResponsePutEntry
+
+`TESIResponsePutEntry<K extends TEndPointPut>` represents the entry details for the "put" method.
+
+```typescript
+type TESIResponsePutEntry<K extends TEndPointPut> = TESIResponseOKMap["put"][K];
+```
+
+### TESIResponsePostEntry
+
+`TESIResponsePostEntry<K extends TEndPointPost>` represents the entry details for the "post" method.
+
+```typescript
+type TESIResponsePostEntry<K extends TEndPointPost> = TESIResponseOKMap["post"][K];
+```
+
+### TESIResponseDeleteEntry
+
+`TESIResponseDeleteEntry<K extends TEndPointDelete>` represents the entry details for the "delete" method.
+
+```typescript
+type TESIResponseDeleteEntry<K extends TEndPointDelete> = TESIResponseOKMap["delete"][K];
+```

package/package.json

@@ -1,13 +1,10 @@
 {
   "name": "eve-esi-types",
-  "version": "2.0.5-beta",
-  "description": "Extracted the main type of ESI. use for ESI request response types",
-  "main": "src/index.d.ts",
+  "version": "2.1.2",
+  "description": "Extracted the main type of ESI. use for ESI request response types (version 2 only)",
+  "main": "v2/index.d.ts",
   "scripts": {
-    "v": "jstool -cmd version",
-    "v:tag": "bash -c \"ret=$(npm run v); after=$(echo $ret | sed -E 's/.*version updated: ([0-9]+\\.[0-9]+\\.[0-9]+(-\\w+)?).*/\\1/'); echo version=[$after]; git add -u; git commit -m v$after; git tag v$after\"",
-    "test": "node esi-request.mjs",
-    "test:v2": "node v2.mjs"
+    "test": "node v2.mjs"
   },
   "repository": {
     "type": "git",
@@ -15,13 +12,12 @@
   },
   "files": [
     "v2",
-    "src",
     "v2.mjs",
+    "v2.d.mts",
     "LICENSE",
-    "README.md",
+    "*.md",
     "package.json",
-    "tsconfig.json",
-    "esi-request.mjs"
+    "tsconfig.json"
   ],
   "keywords": [
     "eve",

package/tsconfig.json

@@ -3,6 +3,7 @@
   "compilerOptions": {
     "skipDefaultLibCheck": true,
     "skipLibCheck": true,
+    "declaration": true,
     "outDir": ".", 
     "target": "esnext",
     "module": "esnext",