Skip to content

fix(openapi-typescript): prevent type error when items is boolean #2260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(openapi-typescript): prevent type error when items is boolean #2260

wants to merge 3 commits into from
+19 −1

Conversation

zrosenbauer
Copy link

Changes

Prevents a TypeError due to a bad in operator for type: "array".

Example: https://json-schema.org/understanding-json-schema/reference/array

How to Review

Take it as it is :)

Checklist

  • Unit tests updated
  • docs/ updated (if necessary)
  • pnpm run update:examples run (only applicable for openapi-typescript)

Sorry, something went wrong.

@zrosenbauer zrosenbauer requested a review from a team as a code owner April 22, 2025 20:24
@zrosenbauer zrosenbauer requested a review from kerwanp April 22, 2025 20:24
@netlify Netlify
Copy link

netlify bot commented Apr 22, 2025 •
edited
Loading

👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit efccb28

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Apr 22, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: efccb28

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@zrosenbauer
fix: add EOL
Loading
Loading status checks…
ea144c0
@zrosenbauer
fix: linting
Loading
Loading status checks…
efccb28
@zrosenbauer
Copy link
Author

@kerwanp I'm not sure if I need to add a changeset or not, I only saw a handful currently there so I'm assuming it's either new or not used.

Please let me know, happy to add one if needed

drwpow
drwpow approved these changes May 3, 2025
View reviewed changes
Copy link
Contributor

@drwpow drwpow left a comment

Choose a reason for hiding this comment

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

This looks great! Please just add a patch changeset (see comment) so we can credit you for this fix, and also push a release after merge.

packages/openapi-typescript/src/transform/schema-object.ts
* @param key - The key to check for
* @returns True if the object has the key, false otherwise
*/
function hasKey<K extends string>(possibleObject: unknown, key: K): possibleObject is { [key in K]: unknown } {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a great idea, thank you!

packages/openapi-typescript/test/transform/schema-object/array.test.ts
@@ -18,6 +18,14 @@ describe("transformSchemaObject > array", () => {
// options: DEFAULT_OPTIONS,
},
],
// Prevents: "TypeError: Cannot use 'in' operator to search for 'type' in true"
[
"boolean items",
Copy link
Contributor

Choose a reason for hiding this comment

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

Great test!

@drwpow drwpow self-assigned this May 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drwpow drwpow

@kerwanp kerwanp

Assignees

@drwpow drwpow

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@zrosenbauer @drwpow