Skip to content

chore: regenerate client from updated OpenAPI spec#7

Open
hotdata-automation[bot] wants to merge 1 commit intomainfrom
openapi-update
Open

chore: regenerate client from updated OpenAPI spec#7
hotdata-automation[bot] wants to merge 1 commit intomainfrom
openapi-update

Conversation

@hotdata-automation
Copy link

Auto-generated from updated HotData OpenAPI spec.

@hotdata-automation hotdata-automation bot force-pushed the openapi-update branch 3 times, most recently from c6dbf0d to 9adce2b Compare March 14, 2026 03:46
@github-actions
Copy link

Automated review unavailable (Claude step failed). Please review manually.

@zfarrell zfarrell closed this Mar 14, 2026
@zfarrell zfarrell reopened this Mar 14, 2026
wwwroot/*.js
node_modules
typings
dist
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
"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,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
"declaration": true,
"declaration": true,
"strict": true,
"target": "es6",

"prepublishOnly": "npm run build"
"build": "tsc && tsc -p tsconfig.esm.json",
"prepare": "npm run build"
},
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".

Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review

Issues

  • P0 – .gitignore drops .env (.gitignore line 4): The generator replaced the existing .gitignore with its own template, silently removing the .env entry. Any developer with a local .env file containing API tokens can now accidentally commit credentials.

  • P1 – Unfilled generator placeholder (package.json line 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: true removed (tsconfig.json): The generator's default tsconfig omits strict mode entirely. This disables strictNullChecks, noImplicitAny, and related checks across the entire SDK, which undermines type safety.

Action Required

  1. Restore .env (and *.tsbuildinfo) in .gitignore.
  2. Replace GIT_USER_ID/GIT_REPO_ID with hotdata-dev/sdk-typescript in package.json.
  3. Add "strict": true back to tsconfig.json compilerOptions.

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.

"author": "OpenAPI-Generator",
"repository": {
"type": "git",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 — Unfilled template placeholder. This will be published to npm with an invalid repository URL. Replace with the actual repo:

Suggested change
"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",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 — Generator boilerplate. author should identify the actual maintainer, not the tool that generated the code.

Suggested change
"author": "OpenAPI-Generator",
"author": "HotData",

"target": "ES2022",
"module": "Node16",
"moduleResolution": "Node16",
"declaration": true,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
"declaration": true,
"declaration": true,
"strict": true,

Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:3strict: true was dropped by the generator's default config. The previous tsconfig had it enabled; removing it silently disables noImplicitAny, strictNullChecks, and related checks across the entire SDK.

Action Required

  1. Fix package.json repository.url to https://github.com/hotdata-dev/sdk-typescript.git.
  2. Re-add "strict": true to tsconfig.json compilerOptions. 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.

wwwroot/*.js
node_modules
typings
dist
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unresolved OpenAPI Generator template placeholder. This needs to point to the actual repository before publishing.

Suggested change
"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",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
"target": "es6",
"target": "ES2022",

Comment on lines 11 to 16
},
"include": ["src"]
"exclude": [
"dist",
"node_modules"
]
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
},
"include": ["src"]
"exclude": [
"dist",
"node_modules"
]
}
},
"include": ["src"]
}

Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  1. Add .env back to .gitignore
  2. Replace GIT_USER_ID/GIT_REPO_ID in package.json with hotdata-dev/sdk-typescript
  3. Restore strict: true, target: "ES2022", rootDir: "src", and esModuleInterop: true in tsconfig.json — or configure the OpenAPI generator to preserve these settings so they survive future regenerations

"author": "OpenAPI-Generator",
"repository": {
"type": "git",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unresolved generator placeholder — this will ship to npm with a broken repository URL. Replace with the actual repo URL:

Suggested change
"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,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
"strict": true,
"strict": true,

Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review

Issues

  • package.json line 8 — Generator placeholder GIT_USER_ID/GIT_REPO_ID left in the repository URL. This will be published to npm with a broken/misleading repo link.

  • tsconfig.jsonstrict: true was removed by the generator. This silently disables strictNullChecks, noImplicitAny, and other checks across the entire SDK. The generated code almost certainly has latent type errors that strict mode would surface.

Action Required

  1. Fix the repository URL in package.json to point to https://github.com/hotdata-dev/sdk-typescript.git
  2. Add "strict": true back to tsconfig.json compilerOptions, and resolve any resulting type errors in the generated code
  3. Consider adding these as overrides in .openapi-generator-ignore or a post-generation patch script so future regenerations do not regress them

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant