eve-esi-types 3.1.6 → 3.1.7

package/docs/v3/replace-path-params.md

@@ -1,60 +0,0 @@
-# Explanation of the `ReplacePathParams` Type
-
-`ReplacePathParams` is a recursive TypeScript type designed to replace dynamic segments—specifically,  
-the path parameters enclosed in curly braces—in a string literal with a standardized template literal interpolation of `${number}`.  
-This is especially useful when defining API endpoints where parameters in the URL are expected to be numeric.
-
-## Type Definition
-
-```typescript
-type ReplacePathParams<T extends unknown> = T extends `${infer Start}{${infer Param}}${infer End}`
-  ? `${Start}${number}${ReplacePathParams<End>}`
-  : T;
-```
-
-### Parameters
-
- + T extends unknown Although T is declared with the type unknown, it is intended to be a string literal representing the endpoint path.  
-   The type processes the string to find dynamic segments that need to be replaced.
-
-### How It Works
-
-1. Pattern Matching The type checks if the input string T matches the pattern:
-
-   `${infer Start}{${infer Param}}${infer End}`
-
- + `Start`: Captures the substring leading up to the first occurrence of a path parameter.
-
- + `{${infer Param}}`: Matches a section of the string enclosed in curly braces. The content inside the braces, which is the path parameter's name, is stored temporarily in Param.
-
- + `End`: Captures the remaining part of the string following the matched dynamic segment.
-
-2. **Recursive Replacement** If the pattern is matched:
-
- + The matching segment `{${infer Param}}` is replaced with `${number}`.
-
- + The type then recursively applies itself to the remainder of the string (`End`) by calling `ReplacePathParams<End>`,  
-   ensuring that all occurrences of path parameters are replaced.
-
-3. Base Case If `T` does not contain any substring that fits the pattern (i.e., no occurrence of a dynamic segment in curly braces),  
-   the type simply evaluates to `T` without modification. This serves as the termination condition for the recursion.
-
-### Practical Example
-
-```ts
-type Example = ReplacePathParams<"/characters/{character_id}/fittings/{fitting_id}/">;
-// Evaluates to: "/characters/${number}/fittings/${number}/"
-```
-
-In this example:
-
-1. The first dynamic segment `{character_id}` is replaced with `${number}`.
-
-1. The type then recursively processes the remaining string, encountering and replacing {fitting_id} with `${number}`.
-
-1. The final resulting type is `"/characters/${number}/fittings/${number}/"`.
-
----
-
-The `ReplacePathParams` type is a powerful tool for transforming endpoint strings into a more standardized format.  
-This is especially beneficial when type-checking API route definitions or dynamically generating strongly-typed URL strings based on certain conditions.

package/docs/v3/resolved-endpoint.md

@@ -1,44 +0,0 @@
-# Explanation of the `ResolvedEndpoint` Type
-
-`ResolvedEndpoint` is a utility TypeScript type that determines the final, "resolved" endpoint based on a given real endpoint and the specific HTTP method. It leverages the `InferEndpointOrigin` type to deduce the original parameterized endpoint from the real endpoint. If no matching parameterized endpoint is found (i.e., the inference results in `never`), it defaults back to the real endpoint.
-
-## Type Definition
-
-```typescript
-type ResolvedEndpoint<
-  RealEP extends unknown, M extends TESIEntryMethod,
-> = InferEndpointOrigin<RealEP, M> extends never ? RealEP : InferEndpointOrigin<RealEP, M>;
-```
-
-## Template Parameters
-
-- **`RealEP extends unknown`**  
-  The real endpoint path, representing the actual URL used in a request (for example, `"/characters/123/fittings/456/"`).
-
-- **`M extends TESIEntryMethod`**  
-  The HTTP method (such as `"get"`, `"post"`, `"delete"`, etc.) used for the request. This is used to narrow down which set of parameterized endpoints should be considered.
-
-## How It Works
-
-1. **Endpoint Inference**  
-   The type starts by invoking `InferEndpointOrigin<RealEP, M>`, which attempts to map the real endpoint to its original parameterized form (e.g., converting `"/characters/123/fittings/456/"` to `"/characters/{character_id}/fittings/{fitting_id}/"`).
-
-2. **Conditional Resolution**  
-   - If `InferEndpointOrigin<RealEP, M>` results in `never`, it means no matching parameterized endpoint could be inferred from the given real endpoint. In such cases, the type falls back and returns `RealEP` as is.
-   - If the inference is successful, the resolved parameterized endpoint is returned.
-
-## Practical Example
-
-```ts
-type Resolved = ResolvedEndpoint<"/characters/123/fittings/456/", "delete">;
-// Evaluates to: "/characters/{character_id}/fittings/{fitting_id}/"
-```
-
-In this example:
-- The real endpoint `"/characters/123/fittings/456/"` along with the HTTP method `"delete"` is provided.
-- `InferEndpointOrigin` successfully maps it to its original form (`"/characters/{character_id}/fittings/{fitting_id}/"`), so that becomes the resolved endpoint.
-- If the mapping had failed (i.e., if no parameterized endpoint matched), the type would have defaulted to returning the original real endpoint.
-
----
-
-`ResolvedEndpoint` thus ensures that you get a consistent and properly parameterized endpoint format, which is crucial for maintaining type safety and clarity in API route definitions.