chore: update ESLint configuration to ignore openapi-client directory #94
+2,608
−224
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fix: update import path for OpenAPI client in clientConfig.ts chore: modify openapi-ts configuration to include client-axios plugin chore: bump package versions in package.json and pnpm-lock.yaml fix: update watcher script to use pnpm for generating client on file change
Reviewer's GuideThis PR upgrades the OpenAPI client generation to @hey-api/[email protected] (including Axios support and SSE streams), adjusts linting to ignore the generated directory, updates package dependencies and scripts, and regenerates all client types, SDK functions, and core utilities to match the new codegen API. Class diagram for regenerated OpenAPI client types and SDKclassDiagram
class Client {
+buildUrl(options)
+connect(options)
+delete(options)
+get(options)
+getConfig()
+head(options)
+instance: AxiosInstance
+options(options)
+patch(options)
+post(options)
+put(options)
+request(options)
+setConfig(config)
+sse: SseMethods
+trace(options)
}
class SseMethods {
+connect(options)
+delete(options)
+get(options)
+head(options)
+options(options)
+patch(options)
+post(options)
+put(options)
+trace(options)
}
class Config {
+auth
+bodySerializer
+headers
+method
+querySerializer
+requestValidator
+responseTransformer
+responseValidator
+axios
+baseURL
+throwOnError
}
class RequestOptions {
+body
+path
+query
+security
+url
+headers
+onSseError
+onSseEvent
+sseDefaultRetryDelay
+sseMaxRetryAttempts
+sseMaxRetryDelay
}
class ServerSentEventsOptions {
+fetch
+onRequest
+onSseError
+onSseEvent
+serializedBody
+sseDefaultRetryDelay
+sseMaxRetryAttempts
+sseMaxRetryDelay
+sseSleepFn
+url
}
class ServerSentEventsResult {
+stream: AsyncGenerator
}
Client --> Config
Client --> SseMethods
SseMethods --> ServerSentEventsResult
RequestOptions --> Config
ServerSentEventsOptions --> ServerSentEventsResult
Class diagram for updated API response and error typesclassDiagram
class AuthJwtLoginResponses {
+200: BearerResponse
}
class AuthJwtLoginErrors {
+400: ErrorModel
+422: HttpValidationError
}
class RegisterRegisterResponses {
+201: UserRead
}
class RegisterRegisterErrors {
+400: ErrorModel
+422: HttpValidationError
}
class ResetForgotPasswordResponses {
+202: unknown
}
class ResetForgotPasswordErrors {
+422: HttpValidationError
}
class ResetResetPasswordResponses {
+200: unknown
}
class ResetResetPasswordErrors {
+400: ErrorModel
+422: HttpValidationError
}
class VerifyRequestTokenResponses {
+202: unknown
}
class VerifyRequestTokenErrors {
+422: HttpValidationError
}
class VerifyVerifyResponses {
+200: UserRead
}
class VerifyVerifyErrors {
+400: ErrorModel
+422: HttpValidationError
}
class UsersCurrentUserResponses {
+200: UserRead
}
class UsersCurrentUserErrors {
+401: unknown
}
class UsersDeleteUserResponses {
+204: void
}
class UsersDeleteUserErrors {
+401: unknown
+403: unknown
+404: unknown
+422: HttpValidationError
}
class UsersUserResponses {
+200: UserRead
}
class UsersUserErrors {
+401: unknown
+403: unknown
+404: unknown
+422: HttpValidationError
}
class UsersPatchUserResponses {
+200: UserRead
}
class UsersPatchUserErrors {
+400: ErrorModel
+401: unknown
+403: unknown
+404: unknown
+422: HttpValidationError
}
Class diagram for new and updated data models (types.gen.ts)classDiagram
class BearerResponse {
+access_token: string
+token_type: string
}
class BodyAuthResetForgotPassword {
+email: string
}
class BodyAuthResetResetPassword {
+token: string
+password: string
}
class BodyAuthVerifyRequestToken {
+email: string
}
class BodyAuthVerifyVerify {
+token: string
}
class ErrorModel {
+detail: string | object
}
class HttpValidationError {
+detail: Array<ValidationError>
}
class ItemCreate {
+name: string
+description: string | null
+quantity: number | null
}
class ItemRead {
+name: string
+description: string | null
+quantity: number | null
+id: string
+user_id: string
}
class PageItemRead {
+items: Array<ItemRead>
+total: number | null
+page: number | null
+size: number | null
+pages: number | null
}
class UserCreate {
+email: string
+password: string
+is_active: boolean | null
+is_superuser: boolean | null
+is_verified: boolean | null
}
class UserRead {
+id: string
+email: string
+is_active: boolean
+is_superuser: boolean
+is_verified: boolean
}
class UserUpdate {
+password: string | null
+email: string | null
+is_active: boolean | null
+is_superuser: boolean | null
+is_verified: boolean | null
}
class ValidationError {
+loc: Array<string | number>
+msg: string
+type: string
}
class Login {
+grant_type: string | null
+username: string
+password: string
+scope: string
+client_id: string | null
+client_secret: string | null
}
File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- This PR combines dependency bumps, ESLint config updates, and a massive auto-generated client—consider splitting the config and dependency changes from the generated code into separate commits or PRs to make reviews clearer.
- The watcher script was updated to use pnpm but other scripts still reference npm; please standardize your package manager calls across all scripts to avoid confusion.
- You’ve added openapi-client/** to ESLint ignores, but you may also want to exclude this folder in tsconfig or IDE settings so generated types aren’t unnecessarily type-checked during development.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- This PR combines dependency bumps, ESLint config updates, and a massive auto-generated client—consider splitting the config and dependency changes from the generated code into separate commits or PRs to make reviews clearer.
- The watcher script was updated to use pnpm but other scripts still reference npm; please standardize your package manager calls across all scripts to avoid confusion.
- You’ve added openapi-client/** to ESLint ignores, but you may also want to exclude this folder in tsconfig or IDE settings so generated types aren’t unnecessarily type-checked during development.
## Individual Comments
### Comment 1
<location> `nextjs-frontend/app/openapi-client/client/types.gen.ts:199` </location>
<code_context>
+> &
+ Omit<TData, "url">;
+
+export type OptionsLegacyParser<
+ TData = unknown,
+ ThrowOnError extends boolean = boolean,
</code_context>
<issue_to_address>
**issue (complexity):** Consider introducing a ReplaceProps utility type to flatten the complex conditional type definitions for OptionsLegacyParser and Options.
```suggestion
// Introduce a small helper to avoid deeply nested branches:
type ReplaceProps<Base, Overrides> = Omit<Base, keyof Overrides> & Overrides;
// Then you can collapse the 4-branch `OptionsLegacyParser` into a single union:
export type OptionsLegacyParser<
TData = unknown,
ThrowOnError extends boolean = boolean
> = ReplaceProps<RequestOptions<unknown, ThrowOnError>, TData>;
// Optionally also simplify `Options` the same way:
export type Options<
TData extends TDataShape = TDataShape,
ThrowOnError extends boolean = boolean,
TResponse = unknown,
> = ReplaceProps<
RequestOptions<TResponse, ThrowOnError>,
Omit<TData, 'url'>
>;
```
Steps:
1. Add the `ReplaceProps` utility at the top.
2. Replace the conditional `OptionsLegacyParser` definition with the single‐line version above.
3. Update `Options` similarly if desired.
This preserves all branches (you can still pass `{ body }` or `{ headers }`) without the nested `extends` logic.
</issue_to_address>
### Comment 2
<location> `nextjs-frontend/app/openapi-client/client/utils.gen.ts:23-65` </location>
<code_context>
const querySerializer = (queryParams: T) => {
const search: string[] = [];
if (queryParams && typeof queryParams === "object") {
for (const name in queryParams) {
const value = queryParams[name];
if (value === undefined || value === null) {
continue;
}
if (Array.isArray(value)) {
const serializedArray = serializeArrayParam({
allowReserved,
explode: true,
name,
style: "form",
value,
...array,
});
if (serializedArray) search.push(serializedArray);
} else if (typeof value === "object") {
const serializedObject = serializeObjectParam({
allowReserved,
explode: true,
name,
style: "deepObject",
value: value as Record<string, unknown>,
...object,
});
if (serializedObject) search.push(serializedObject);
} else {
const serializedPrimitive = serializePrimitiveParam({
allowReserved,
name,
value: value as string,
});
if (serializedPrimitive) search.push(serializedPrimitive);
}
}
}
return search.join("&");
};
return querySerializer;
</code_context>
<issue_to_address>
**suggestion (code-quality):** Inline variable that is immediately returned ([`inline-immediately-returned-variable`](https://docs.sourcery.ai/Reference/Rules-and-In-Line-Suggestions/TypeScript/Default-Rules/inline-immediately-returned-variable))
```suggestion
return (queryParams: T) => {
const search: string[] = [];
if (queryParams && typeof queryParams === "object") {
for (const name in queryParams) {
const value = queryParams[name];
if (value === undefined || value === null) {
continue;
}
if (Array.isArray(value)) {
const serializedArray = serializeArrayParam({
allowReserved,
explode: true,
name,
style: "form",
value,
...array,
});
if (serializedArray) search.push(serializedArray);
} else if (typeof value === "object") {
const serializedObject = serializeObjectParam({
allowReserved,
explode: true,
name,
style: "deepObject",
value: value as Record<string, unknown>,
...object,
});
if (serializedObject) search.push(serializedObject);
} else {
const serializedPrimitive = serializePrimitiveParam({
allowReserved,
name,
value: value as string,
});
if (serializedPrimitive) search.push(serializedPrimitive);
}
}
}
return search.join("&");
};
```
<br/><details><summary>Explanation</summary>Something that we often see in people's code is assigning to a result variable
and then immediately returning it.
Returning the result directly shortens the code and removes an unnecessary
variable, reducing the mental load of reading the function.
Where intermediate variables can be useful is if they then get used as a
parameter or a condition, and the name can act like a comment on what the
variable represents. In the case where you're returning it from a function, the
function name is there to tell you what the result is, so the variable name
is unnecessary.
</details>
</issue_to_address>
### Comment 3
<location> `nextjs-frontend/app/openapi-client/client/utils.gen.ts:138` </location>
<code_context>
query: !options.paramsSerializer ? options.query : undefined,
</code_context>
<issue_to_address>
**suggestion (code-quality):** Invert ternary operator to remove negation ([`invert-ternary`](https://docs.sourcery.ai/Reference/Rules-and-In-Line-Suggestions/TypeScript/Default-Rules/invert-ternary))
```suggestion
query: options.paramsSerializer ? undefined : options.query,
```
<br/><details><summary>Explanation</summary>Negated conditions are more difficult to read than positive ones, so it is best
to avoid them where we can. By inverting the ternary condition and swapping the
expressions we can simplify the code.
</details>
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
chore: update @hey-api/openapi-ts to the latest version #74
Description
Current State
Breaking Changes Impact Assessment
Critical Changes (0.60 → 0.83):
Motivation and Context
Screenshots (if appropriate):
Steps to reproduce (if appropriate):
Types of changes
Checklist: