Skip to content
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.

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

Update tsconfig and make nav interfaces exposable for consumption #1223

Merged
merged 3 commits into from
Nov 7, 2024

Conversation

sandrahoang686
Copy link
Collaborator

@sandrahoang686 sandrahoang686 commented Oct 29, 2024

Related Ticket: #1186
Related PR: developmentseed/next-veda-ui#10

Note
To expose interfaces from veda-ui - they should be defined in .ts files vs .d.ts files. This is because parcel isn't building the typescript definition files into lib/index.d.ts but does so when the file is .ts.

When building the library with .d.ts extension - there are NO type hints from NextInstance side
Screenshot 2024-11-04 at 9 23 19 AM

When building the library with .ts extension - there are type hints form NextInstance side
Screenshot 2024-11-04 at 9 20 02 AM

Description of Changes

  • Update typescript definition file of nav types to typescript file
  • Add declaration true to tsconfig

Notes & Questions About Changes

Found this thread about typescript definition files and parcel build here parcel-bundler/parcel#1240

Validation / Testing

{Update with info on what can be manually validated in the Deploy Preview link for example "Validate style updates to selection modal do NOT affect cards"}

Copy link

netlify bot commented Oct 29, 2024

Deploy Preview for veda-ui ready!

Name Link
🔨 Latest commit 0438c6b
🔍 Latest deploy log https://app.netlify.com/sites/veda-ui/deploys/672d009f76e9e80008d2d519
😎 Deploy Preview https://deploy-preview-1223--veda-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sandrahoang686 sandrahoang686 changed the title update tsconfig and update type imports Update tsconfig and make nav interfaces exposable for consumption Nov 4, 2024
@sandrahoang686 sandrahoang686 marked this pull request as ready for review November 4, 2024 14:55
@dzole0311
Copy link
Collaborator

Thanks for fixing, I'm getting the correct type annotations now ✅

@sandrahoang686 sandrahoang686 force-pushed the 1186-techdebt-expose-types-for-library branch from b8366ef to 0839c98 Compare November 7, 2024 14:43
Copy link
Collaborator

@hanbyul-here hanbyul-here left a comment

Choose a reason for hiding this comment

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

I checked the built asset (lib/index.d.ts) has Nav related types. thanks for working on it 🙇 Maybe easy lint warnings can be fixed (ex. linebreaks) can be fixed since we are on it? but not a blocker !

@@ -5,6 +5,7 @@
"moduleResolution": "node",
"esModuleInterop": true,
"strictNullChecks": true,
"declaration": true,
Copy link
Collaborator

Choose a reason for hiding this comment

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

for my education, can you tell me what this line does?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@sandrahoang686 sandrahoang686 merged commit adb8741 into main Nov 7, 2024
9 checks passed
@sandrahoang686 sandrahoang686 deleted the 1186-techdebt-expose-types-for-library branch November 7, 2024 18:04
@AliceR AliceR mentioned this pull request Nov 11, 2024
AliceR added a commit that referenced this pull request Nov 12, 2024
## 🎉 Features
* Card image/description independent of hero image/description by
@dzole0311 in #1244

## 🚀 Improvements
* Cookie consent code cleanup by @snmln in
#1199 , and @hanbyul-here in
#1240 , and @hanbyul-here in
#1241
* Add ADR about design system change by @j08lue in
#890
* Update condition to run playwright tests on release branches by
@dzole0311 in #1228
* Update STYLE_GUIDE.md by @AliceR in
#1227
* Fix lint configuration by @AliceR in
#1219
* Add tests for the AOI feature specification by @AliceR in
#1216
* Set data catalog filters to be closed by default by @vgeorge in
#1243
* Update tsconfig and make nav interfaces exposable for consumption by
@sandrahoang686 in #1223

## 🐛 Fixes
* Hotfix to hide the external link badge from cards by @dzole0311 in
#1231

## New Contributors
* @vgeorge made their first contribution in
#1243

**Full Changelog**:
v5.9.0...v5.10.0
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.

3 participants