refactor: Add types to useRepositoriesList hook #277

chadstewart · 2022-08-29T16:15:27Z

What type of PR is this? (check all applicable)

Description

This PR adds the feature of adding types to the API response from the repo/list end point.

Details:

Created the file next-types.d.ts and moved the types into this file. This is the file we will add our types to for refactor: correct typescript types usage across the application #212. You can learn a bit more about this here (the documentation recommends the file name additional.d.ts).
Types RepoList and Meta are the responses copied over from the GitSense API response.

Related Tickets & Documents

Fixes #273

Mobile & Desktop Screenshots/Recordings

Added tests?

👍 yes
🙅 no, because they aren't needed
🙋 no, because I need help

Added to documentation?

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

…his.

netlify · 2022-08-29T16:15:32Z

✅ Deploy Preview for oss-insights ready!

Name	Link
🔨 Latest commit	`cde4361`
🔍 Latest deploy log	https://app.netlify.com/sites/oss-insights/deploys/63113103847fe700078ce00b
😎 Deploy Preview	https://deploy-preview-277--oss-insights.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2022-08-29T16:16:07Z

✅ Deploy Preview for design-insights ready!

Name	Link
🔨 Latest commit	`cde4361`
🔍 Latest deploy log	https://app.netlify.com/sites/design-insights/deploys/63113103ab737600089ad8e7
😎 Deploy Preview	https://deploy-preview-277--design-insights.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

chadstewart · 2022-08-29T16:20:38Z

Hey @0-vortex, is this what you meant for this issue?

https://github.com/open-sauced/insights/pull/277/files#diff-c197a4a84dd47a520b5440e671dbf06b802968a8ea673ce6e30b47617a4341e3R3-R43

bdougie · 2022-08-30T12:43:16Z

Hey @0-vortex, is this what you meant for this issue?

These types might be better in a https://github.com/open-sauced/hot/blob/beta/src/vite-types.d.ts like file than inline in the hook. The link provided is vite, but next recommend something similar.

…that the entire app has access to these types.

0-vortex · 2022-08-30T20:10:51Z

Hey @0-vortex, is this what you meant for this issue?

These types might be better in a https://github.com/open-sauced/hot/blob/beta/src/vite-types.d.ts like file than inline in the hook. The link provided is vite, but next recommend something similar.

Correct, database types should be renamed to DbType and conform to the types displayed in the API. With that being said, this PR was supposed to correct the SWR usage, as the initial types mocked single repo usage, not a list. As this was not correctly implemented anywhere, adding the correct types in does not call it a day. 😅

I'm adding the required steps to make this ready for some prime time usage, we will have the same kind of listings across all API services, so it doesn't make sense to avoid doing this.

0-vortex

"minor" changes 😅

additional.d.ts

components/molecules/SelectableTable/repository-table.tsx

components/organisms/Dashboard/dashboard.tsx

lib/hooks/useDashboardData.ts

lib/hooks/useNav.ts

lib/hooks/useRepositoriesList.ts

tsconfig.json

…named selectabletable file to repository table. Will reach out to TED for help with remaining code review updates.

components/molecules/RepositoryTable/repository-table.tsx

…tex.

bdougie

Looks good

0-vortex

LGTM! 👍

## [1.4.0-beta.2](v1.4.0-beta.1...v1.4.0-beta.2) (2022-09-02) ### 🧑‍💻 Code Refactoring * Add types to useRepositoriesList hook ([#277](#277)) ([4f1a771](4f1a771))

github-actions · 2022-09-02T01:51:52Z

🎉 This PR is included in version 1.4.0-beta.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

## [1.4.0](v1.3.0...v1.4.0) (2022-09-06) ### 🧑‍💻 Code Refactoring * Add types to useRepositoriesList hook ([#277](#277)) ([4f1a771](4f1a771)) ### 🍕 Features * Add download CSV funtionality to Reports page ([#286](#286)) ([ada79d3](ada79d3)) * **footer:** swap out footer text ([#296](#296)) ([737df5b](737df5b)) * Update Scatter Chart Legend ([#260](#260)) ([309ef62](309ef62)) ### 🐛 Bug Fixes * Add background to selectable tr table ([#252](#252)) ([7d6ae16](7d6ae16)), closes [#183](#183) [#289](#289) * Contributor card overlap on smaller devices ([#298](#298)) ([777f6ba](777f6ba)), closes [#290](#290) * correct netlify build supabase redirect url ([#283](#283)) ([0b2b80a](0b2b80a)) * Filter dropdown can only be closed by clicking on the filter button ([#299](#299)) ([bce1f8e](bce1f8e)), closes [#292](#292) * Fixing issues with TopNav and Highlight Card ([#294](#294)) ([218f30d](218f30d)), closes [#287](#287) [#291](#291) * grammar for header description ([#279](#279)) ([a019912](a019912))

## [1.4.0-beta.2](open-sauced/app@v1.4.0-beta.1...v1.4.0-beta.2) (2022-09-02) ### 🧑‍💻 Code Refactoring * Add types to useRepositoriesList hook ([#277](open-sauced/app#277)) ([4f1a771](open-sauced/app@4f1a771))

## [1.4.0](open-sauced/app@v1.3.0...v1.4.0) (2022-09-06) ### 🧑‍💻 Code Refactoring * Add types to useRepositoriesList hook ([#277](open-sauced/app#277)) ([4f1a771](open-sauced/app@4f1a771)) ### 🍕 Features * Add download CSV funtionality to Reports page ([#286](open-sauced/app#286)) ([ada79d3](open-sauced/app@ada79d3)) * **footer:** swap out footer text ([#296](open-sauced/app#296)) ([737df5b](open-sauced/app@737df5b)) * Update Scatter Chart Legend ([#260](open-sauced/app#260)) ([309ef62](open-sauced/app@309ef62)) ### 🐛 Bug Fixes * Add background to selectable tr table ([#252](open-sauced/app#252)) ([7d6ae16](open-sauced/app@7d6ae16)), closes [#183](open-sauced/app#183) [#289](open-sauced/app#289) * Contributor card overlap on smaller devices ([#298](open-sauced/app#298)) ([777f6ba](open-sauced/app@777f6ba)), closes [#290](open-sauced/app#290) * correct netlify build supabase redirect url ([#283](open-sauced/app#283)) ([0b2b80a](open-sauced/app@0b2b80a)) * Filter dropdown can only be closed by clicking on the filter button ([#299](open-sauced/app#299)) ([bce1f8e](open-sauced/app@bce1f8e)), closes [#292](open-sauced/app#292) * Fixing issues with TopNav and Highlight Card ([#294](open-sauced/app#294)) ([218f30d](open-sauced/app@218f30d)), closes [#287](open-sauced/app#287) [#291](open-sauced/app#291) * grammar for header description ([#279](open-sauced/app#279)) ([a019912](open-sauced/app@a019912))

chadstewart added 2 commits August 29, 2022 10:42

Initial commit of updating useRepositories hook types.

c22f98f

Added interface for RepoList api response. Need someone to critique t…

3368adf

…his.

chadstewart changed the title ~~refactot!: Added types to useRepositoriesList hook~~ refactor!: Added types to useRepositoriesList hook Aug 29, 2022

chadstewart added 2 commits August 30, 2022 08:51

Moving repo type definitions to a new file called additional.d.ts so …

72c74a8

…that the entire app has access to these types.

Corrected type errors from the change to RepoList type change.

349ac8f

chadstewart requested review from bdougie and 0-vortex August 30, 2022 16:13

chadstewart marked this pull request as ready for review August 30, 2022 16:13

0-vortex suggested changes Aug 30, 2022

View reviewed changes

Updated types and humanizing item count based on code review. Also re…

4db3ac6

…named selectabletable file to repository table. Will reach out to TED for help with remaining code review updates.

bdougie reviewed Aug 31, 2022

View reviewed changes

components/molecules/RepositoryTable/repository-table.tsx Outdated Show resolved Hide resolved

Made some changes based on code review and pairing session with 0-vor…

0463fba

…tex.

chadstewart requested review from 0-vortex and bdougie August 31, 2022 20:00

chadstewart added the awaiting review label Aug 31, 2022

bdougie approved these changes Sep 1, 2022

View reviewed changes

chadstewart added 3 commits September 1, 2022 10:29

Added updates around simple error handling based on code review.

65b5715

Making some changes based on code review feedback.

703f28d

Removed duplicate type from types definition file.

eecc9b0

chadstewart changed the title ~~refactor!: Added types to useRepositoriesList hook~~ refactor: Add types to useRepositoriesList hook Sep 1, 2022

Updated dashboard and repositories based on code review.

cde4361

0-vortex approved these changes Sep 1, 2022

View reviewed changes

chadstewart merged commit 4f1a771 into beta Sep 2, 2022

chadstewart deleted the 273-update-useRepositoriesList-types branch September 2, 2022 01:48

github-actions bot added the released on @beta label Sep 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Add types to useRepositoriesList hook #277

refactor: Add types to useRepositoriesList hook #277

chadstewart commented Aug 29, 2022 •

edited

netlify bot commented Aug 29, 2022 •

edited

netlify bot commented Aug 29, 2022 •

edited

chadstewart commented Aug 29, 2022

bdougie commented Aug 30, 2022

0-vortex commented Aug 30, 2022

0-vortex left a comment

bdougie left a comment

0-vortex left a comment

github-actions bot commented Sep 2, 2022

refactor: Add types to useRepositoriesList hook #277

refactor: Add types to useRepositoriesList hook #277

Conversation

chadstewart commented Aug 29, 2022 • edited

What type of PR is this? (check all applicable)

Description

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

Added tests?

Added to documentation?

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

netlify bot commented Aug 29, 2022 • edited

✅ Deploy Preview for oss-insights ready!

netlify bot commented Aug 29, 2022 • edited

✅ Deploy Preview for design-insights ready!

chadstewart commented Aug 29, 2022

bdougie commented Aug 30, 2022

0-vortex commented Aug 30, 2022

0-vortex left a comment

Choose a reason for hiding this comment

bdougie left a comment

Choose a reason for hiding this comment

0-vortex left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 2, 2022

chadstewart commented Aug 29, 2022 •

edited

netlify bot commented Aug 29, 2022 •

edited

netlify bot commented Aug 29, 2022 •

edited