chore: regenerate client from updated OpenAPI spec#7
chore: regenerate client from updated OpenAPI spec#7hotdata-automation[bot] wants to merge 1 commit intomainfrom
Conversation
c6dbf0d to
9adce2b
Compare
|
Automated review unavailable (Claude step failed). Please review manually. |
| wwwroot/*.js | ||
| node_modules | ||
| typings | ||
| dist |
There was a problem hiding this comment.
P0 – .env no longer ignored
The generator replaced the existing .gitignore and dropped the .env entry. If any developer has a local .env file with API tokens or credentials, it can now be accidentally committed.
| dist | |
| wwwroot/*.js | |
| node_modules | |
| typings | |
| dist | |
| .env | |
| *.tsbuildinfo |
| "author": "OpenAPI-Generator", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" |
There was a problem hiding this comment.
P1 – Unfilled generator placeholder
GIT_USER_ID/GIT_REPO_ID is a template token that OpenAPI Generator leaves in output. It needs to be replaced with the actual repository path before this merges, otherwise npm info @hotdata/sdk will show a broken repository URL.
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" | |
| "url": "https://github.com/hotdata-dev/sdk-typescript.git" |
| "target": "ES2022", | ||
| "module": "Node16", | ||
| "moduleResolution": "Node16", | ||
| "declaration": true, |
There was a problem hiding this comment.
P1 – strict: true removed
The old tsconfig had "strict": true. The generator's default tsconfig omits it entirely, which silently disables all strict checks (strictNullChecks, noImplicitAny, etc.). This weakens type safety across the whole SDK. Consider adding it back to compilerOptions.
| "declaration": true, | |
| "declaration": true, | |
| "strict": true, | |
| "target": "es6", |
| "prepublishOnly": "npm run build" | ||
| "build": "tsc && tsc -p tsconfig.esm.json", | ||
| "prepare": "npm run build" | ||
| }, |
There was a problem hiding this comment.
P2 – license field removed
The previous package.json declared "license": "MIT". The generator dropped it, which means npm will warn on publish and the package will show "none" on npmjs.com. Consider adding it back.
README.md
Outdated
|
|
||
| const body = { | ||
| // string | Connection ID | ||
| connectionId: connectionId_example, |
There was a problem hiding this comment.
P2 – Broken example code
connectionId_example is referenced but never declared. Copy-pasting this snippet produces a ReferenceError at runtime and a compile error with strict mode. All similar examples throughout the docs/ files have the same issue. Replace with an inline string literal, e.g. "my-connection-id".
There was a problem hiding this comment.
Review
Issues
-
P0 –
.gitignoredrops.env(.gitignoreline 4): The generator replaced the existing.gitignorewith its own template, silently removing the.enventry. Any developer with a local.envfile containing API tokens can now accidentally commit credentials. -
P1 – Unfilled generator placeholder (
package.jsonline 8):"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"is an OpenAPI Generator template token. It was not replaced before the PR was raised. -
P1 –
strict: trueremoved (tsconfig.json): The generator's default tsconfig omits strict mode entirely. This disablesstrictNullChecks,noImplicitAny, and related checks across the entire SDK, which undermines type safety.
Action Required
- Restore
.env(and*.tsbuildinfo) in.gitignore. - Replace
GIT_USER_ID/GIT_REPO_IDwithhotdata-dev/sdk-typescriptinpackage.json. - Add
"strict": trueback totsconfig.jsoncompilerOptions.
The automation that runs the generator should either post-process these known artifacts or maintain a set of patches that are re-applied after each regeneration.
9adce2b to
97e1681
Compare
| "author": "OpenAPI-Generator", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" |
There was a problem hiding this comment.
P1 — Unfilled template placeholder. This will be published to npm with an invalid repository URL. Replace with the actual repo:
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" | |
| "url": "https://github.com/hotdata-dev/sdk-typescript.git" |
| "types": "dist/index.d.ts", | ||
| "version": "1.0.0", | ||
| "description": "OpenAPI client for @hotdata/sdk", | ||
| "author": "OpenAPI-Generator", |
There was a problem hiding this comment.
P2 — Generator boilerplate. author should identify the actual maintainer, not the tool that generated the code.
| "author": "OpenAPI-Generator", | |
| "author": "HotData", |
| "target": "ES2022", | ||
| "module": "Node16", | ||
| "moduleResolution": "Node16", | ||
| "declaration": true, |
There was a problem hiding this comment.
P1 — strict: true was dropped. The generator's default tsconfig disables strict mode, but the previous config had it enabled. Without it, noImplicitAny, strictNullChecks, and other safety checks are off — allowing the generated any types to silently widen. Add it back:
| "declaration": true, | |
| "declaration": true, | |
| "strict": true, |
There was a problem hiding this comment.
Review
Issues
- package.json:8 — Repository URL is an unfilled OpenAPI Generator template placeholder (
GIT_USER_ID/GIT_REPO_ID). This will be published to npm with an invalid repository link. - tsconfig.json:3 —
strict: truewas dropped by the generator's default config. The previous tsconfig had it enabled; removing it silently disablesnoImplicitAny,strictNullChecks, and related checks across the entire SDK.
Action Required
- Fix
package.jsonrepository.urltohttps://github.com/hotdata-dev/sdk-typescript.git. - Re-add
"strict": truetotsconfig.jsoncompilerOptions. If generated code does not compile under strict mode, configure the generator to produce stricter output or post-process — do not lower the bar for the whole SDK.
97e1681 to
42936a4
Compare
| wwwroot/*.js | ||
| node_modules | ||
| typings | ||
| dist |
There was a problem hiding this comment.
The generator-provided .gitignore dropped .env, which was present in the original. Without this entry, environment files containing API tokens and secrets could be accidentally committed.
| dist | |
| wwwroot/*.js | |
| node_modules | |
| typings | |
| dist | |
| .env |
| "author": "OpenAPI-Generator", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" |
There was a problem hiding this comment.
Unresolved OpenAPI Generator template placeholder. This needs to point to the actual repository before publishing.
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" | |
| "url": "https://github.com/hotdata-dev/sdk-typescript.git" |
| "module": "Node16", | ||
| "moduleResolution": "Node16", | ||
| "declaration": true, | ||
| "target": "es6", |
There was a problem hiding this comment.
The generator downgraded the compile target from ES2022 to es6 and dropped strict: true. Losing strict mode silently disables null checks, implicit any, strict function types, etc. — type errors that previously would have been caught at compile time can now slip through.
The original config should be preserved for these settings:
| "target": "es6", | |
| "target": "ES2022", |
| }, | ||
| "include": ["src"] | ||
| "exclude": [ | ||
| "dist", | ||
| "node_modules" | ||
| ] | ||
| } |
There was a problem hiding this comment.
strict: true, esModuleInterop: true, and rootDir: "src" were all dropped. strict is the critical one (see comment above). rootDir should also be restored — without it the compiler may pick up files outside src/ and produce a different output tree.
| }, | |
| "include": ["src"] | |
| "exclude": [ | |
| "dist", | |
| "node_modules" | |
| ] | |
| } | |
| }, | |
| "include": ["src"] | |
| } |
There was a problem hiding this comment.
Review
Issues
P0 — .gitignore drops .env
The generator-provided .gitignore removes the .env entry that was in the original. Environment files containing API tokens and other secrets can now be accidentally committed. Must be restored before merge.
P1 — package.json: unresolved template placeholder in repository.url
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" is a raw OpenAPI Generator placeholder. Any tooling (npm, GitHub, pkg managers) that reads this field will get bad data.
P1 — tsconfig.json: strict: true dropped, target downgraded
The generator replaced the project's tsconfig.json with its own defaults, removing strict: true, esModuleInterop: true, rootDir: "src", and downgrading the compile target from ES2022 to es6. Dropping strict is the critical regression — it disables null checks, implicit any detection, and strict function types, meaning type errors that the original config would have caught will now pass silently.
Action Required
- Add
.envback to.gitignore - Replace
GIT_USER_ID/GIT_REPO_IDinpackage.jsonwithhotdata-dev/sdk-typescript - Restore
strict: true,target: "ES2022",rootDir: "src", andesModuleInterop: trueintsconfig.json— or configure the OpenAPI generator to preserve these settings so they survive future regenerations
42936a4 to
a19aff2
Compare
| "author": "OpenAPI-Generator", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" |
There was a problem hiding this comment.
Unresolved generator placeholder — this will ship to npm with a broken repository URL. Replace with the actual repo URL:
| "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git" | |
| "url": "https://github.com/hotdata-dev/sdk-typescript.git" |
| "moduleResolution": "node", | ||
| "outDir": "dist", | ||
| "rootDir": "src", | ||
| "strict": true, |
There was a problem hiding this comment.
strict: true was dropped by the generator. This disables a whole class of TypeScript safety checks (strictNullChecks, noImplicitAny, etc.) across the entire codebase. Add it back to the generated tsconfig.json:
| "strict": true, | |
| "strict": true, |
There was a problem hiding this comment.
Review
Issues
-
package.json line 8 — Generator placeholder
GIT_USER_ID/GIT_REPO_IDleft in the repository URL. This will be published to npm with a broken/misleading repo link. -
tsconfig.json —
strict: truewas removed by the generator. This silently disablesstrictNullChecks,noImplicitAny, and other checks across the entire SDK. The generated code almost certainly has latent type errors thatstrictmode would surface.
Action Required
- Fix the repository URL in
package.jsonto point tohttps://github.com/hotdata-dev/sdk-typescript.git - Add
"strict": trueback totsconfig.jsoncompilerOptions, and resolve any resulting type errors in the generated code - Consider adding these as overrides in
.openapi-generator-ignoreor a post-generation patch script so future regenerations do not regress them
Auto-generated from updated HotData OpenAPI spec.