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

(feat) Update type LoggedInUser to list userProperties in use #744

Merged
merged 3 commits into from
Aug 10, 2023

Conversation

vasharma05
Copy link
Member

Requirements

  • This PR has a title that briefly describes the work done including the ticket number. If there is a ticket, make sure your PR title includes a conventional commit label. See existing PR titles for inspiration.

For changes to apps

If applicable

  • My work includes tests or is validated by existing tests.
  • I have updated the esm-framework mock to reflect any API changes I have made.

Summary

This PR updates the LoggedInUser type to store the already used keys in other apps for better understanding

user.userProperties.patientsVisited used in the patient search for storing patients visited by the user
user.userProperties.starredPatientLists to be used in the patient list app to store the UUIDs of the patient lists starred by the user.

Screenshots

None

Related Issue

Other

@github-actions
Copy link
Contributor

github-actions bot commented Aug 9, 2023

Size Change: -211 kB (-9%) ✅

Total Size: 2.13 MB

Filename Size Change
packages/shell/esm-app-shell/dist/openmrs.e5bf9ffc914c9cf4.js 0 B -211 kB (removed) 🏆
ℹ️ View Unchanged
Filename Size
packages/apps/esm-devtools-app/dist/68.js 4.29 kB
packages/apps/esm-devtools-app/dist/735.js 2.63 kB
packages/apps/esm-devtools-app/dist/889.js 109 kB
packages/apps/esm-devtools-app/dist/988.js 282 B
packages/apps/esm-devtools-app/dist/main.js 2.95 kB
packages/apps/esm-devtools-app/dist/openmrs-esm-devtools-app.js 3.03 kB
packages/apps/esm-implementer-tools-app/dist/102.js 2.76 kB
packages/apps/esm-implementer-tools-app/dist/139.js 11.7 kB
packages/apps/esm-implementer-tools-app/dist/199.js 28.4 kB
packages/apps/esm-implementer-tools-app/dist/242.js 6.71 kB
packages/apps/esm-implementer-tools-app/dist/246.js 447 B
packages/apps/esm-implementer-tools-app/dist/319.js 501 B
packages/apps/esm-implementer-tools-app/dist/369.js 2.63 kB
packages/apps/esm-implementer-tools-app/dist/426.js 1.66 kB
packages/apps/esm-implementer-tools-app/dist/466.js 5.82 kB
packages/apps/esm-implementer-tools-app/dist/499.js 2.77 kB
packages/apps/esm-implementer-tools-app/dist/500.js 2.83 kB
packages/apps/esm-implementer-tools-app/dist/574.js 470 B
packages/apps/esm-implementer-tools-app/dist/587.js 4.18 kB
packages/apps/esm-implementer-tools-app/dist/600.js 62.2 kB
packages/apps/esm-implementer-tools-app/dist/620.js 126 kB
packages/apps/esm-implementer-tools-app/dist/625.js 472 B
packages/apps/esm-implementer-tools-app/dist/657.js 472 B
packages/apps/esm-implementer-tools-app/dist/735.js 2.63 kB
packages/apps/esm-implementer-tools-app/dist/757.js 470 B
packages/apps/esm-implementer-tools-app/dist/788.js 42.9 kB
packages/apps/esm-implementer-tools-app/dist/807.js 1.44 kB
packages/apps/esm-implementer-tools-app/dist/833.js 580 B
packages/apps/esm-implementer-tools-app/dist/889.js 109 kB
packages/apps/esm-implementer-tools-app/dist/895.js 2.27 kB
packages/apps/esm-implementer-tools-app/dist/main.js 4.12 kB
packages/apps/esm-implementer-tools-app/dist/openmrs-esm-implementer-tools-app.js 3.25 kB
packages/apps/esm-login-app/dist/236.js 272 B
packages/apps/esm-login-app/dist/240.js 364 B
packages/apps/esm-login-app/dist/261.js 6.25 kB
packages/apps/esm-login-app/dist/263.js 6.65 kB
packages/apps/esm-login-app/dist/272.js 264 B
packages/apps/esm-login-app/dist/319.js 480 B
packages/apps/esm-login-app/dist/336.js 234 B
packages/apps/esm-login-app/dist/337.js 1.3 kB
packages/apps/esm-login-app/dist/390.js 603 B
packages/apps/esm-login-app/dist/438.js 6 kB
packages/apps/esm-login-app/dist/539.js 298 B
packages/apps/esm-login-app/dist/574.js 428 B
packages/apps/esm-login-app/dist/610.js 5.8 kB
packages/apps/esm-login-app/dist/611.js 726 B
packages/apps/esm-login-app/dist/625.js 421 B
packages/apps/esm-login-app/dist/63.js 16.5 kB
packages/apps/esm-login-app/dist/642.js 10.7 kB
packages/apps/esm-login-app/dist/644.js 305 B
packages/apps/esm-login-app/dist/673.js 284 B
packages/apps/esm-login-app/dist/735.js 2.63 kB
packages/apps/esm-login-app/dist/737.js 24.9 kB
packages/apps/esm-login-app/dist/757.js 509 B
packages/apps/esm-login-app/dist/788.js 42.9 kB
packages/apps/esm-login-app/dist/807.js 685 B
packages/apps/esm-login-app/dist/829.js 10.1 kB
packages/apps/esm-login-app/dist/833.js 528 B
packages/apps/esm-login-app/dist/889.js 109 kB
packages/apps/esm-login-app/dist/main.js 3.48 kB
packages/apps/esm-login-app/dist/openmrs-esm-login-app.js 3.17 kB
packages/apps/esm-offline-tools-app/dist/202.js 9.67 kB
packages/apps/esm-offline-tools-app/dist/206.js 7.37 kB
packages/apps/esm-offline-tools-app/dist/263.js 6.66 kB
packages/apps/esm-offline-tools-app/dist/281.js 12.3 kB
packages/apps/esm-offline-tools-app/dist/290.js 438 B
packages/apps/esm-offline-tools-app/dist/316.js 2.06 kB
packages/apps/esm-offline-tools-app/dist/319.js 1.04 kB
packages/apps/esm-offline-tools-app/dist/391.js 305 B
packages/apps/esm-offline-tools-app/dist/412.js 1.58 kB
packages/apps/esm-offline-tools-app/dist/47.js 6.31 kB
packages/apps/esm-offline-tools-app/dist/501.js 23.4 kB
packages/apps/esm-offline-tools-app/dist/526.js 15.6 kB
packages/apps/esm-offline-tools-app/dist/538.js 6.75 kB
packages/apps/esm-offline-tools-app/dist/541.js 384 B
packages/apps/esm-offline-tools-app/dist/574.js 1.04 kB
packages/apps/esm-offline-tools-app/dist/594.js 11.2 kB
packages/apps/esm-offline-tools-app/dist/625.js 1.04 kB
packages/apps/esm-offline-tools-app/dist/63.js 16.5 kB
packages/apps/esm-offline-tools-app/dist/697.js 5.47 kB
packages/apps/esm-offline-tools-app/dist/733.js 290 B
packages/apps/esm-offline-tools-app/dist/735.js 2.63 kB
packages/apps/esm-offline-tools-app/dist/752.js 2.83 kB
packages/apps/esm-offline-tools-app/dist/757.js 1.21 kB
packages/apps/esm-offline-tools-app/dist/78.js 6.13 kB
packages/apps/esm-offline-tools-app/dist/788.js 42.9 kB
packages/apps/esm-offline-tools-app/dist/807.js 1.03 kB
packages/apps/esm-offline-tools-app/dist/82.js 51.8 kB
packages/apps/esm-offline-tools-app/dist/833.js 1.23 kB
packages/apps/esm-offline-tools-app/dist/889.js 109 kB
packages/apps/esm-offline-tools-app/dist/937.js 6.56 kB
packages/apps/esm-offline-tools-app/dist/967.js 492 B
packages/apps/esm-offline-tools-app/dist/main.js 59.4 kB
packages/apps/esm-offline-tools-app/dist/openmrs-esm-offline-tools-app.js 3.25 kB
packages/apps/esm-primary-navigation-app/dist/113.js 11.6 kB
packages/apps/esm-primary-navigation-app/dist/241.js 13.8 kB
packages/apps/esm-primary-navigation-app/dist/263.js 6.66 kB
packages/apps/esm-primary-navigation-app/dist/319.js 183 B
packages/apps/esm-primary-navigation-app/dist/414.js 467 B
packages/apps/esm-primary-navigation-app/dist/574.js 183 B
packages/apps/esm-primary-navigation-app/dist/625.js 184 B
packages/apps/esm-primary-navigation-app/dist/63.js 16.5 kB
packages/apps/esm-primary-navigation-app/dist/631.js 1.07 kB
packages/apps/esm-primary-navigation-app/dist/710.js 6.44 kB
packages/apps/esm-primary-navigation-app/dist/716.js 6.08 kB
packages/apps/esm-primary-navigation-app/dist/735.js 2.64 kB
packages/apps/esm-primary-navigation-app/dist/743.js 7.17 kB
packages/apps/esm-primary-navigation-app/dist/757.js 209 B
packages/apps/esm-primary-navigation-app/dist/788.js 42.9 kB
packages/apps/esm-primary-navigation-app/dist/807.js 182 B
packages/apps/esm-primary-navigation-app/dist/833.js 210 B
packages/apps/esm-primary-navigation-app/dist/889.js 109 kB
packages/apps/esm-primary-navigation-app/dist/948.js 3.03 kB
packages/apps/esm-primary-navigation-app/dist/main.js 4.78 kB
packages/apps/esm-primary-navigation-app/dist/openmrs-esm-primary-navigation-app.js 3.29 kB
packages/framework/esm-api/dist/openmrs-esm-api.js 9.68 kB
packages/framework/esm-breadcrumbs/dist/openmrs-esm-breadcrumbs.js 2.66 kB
packages/framework/esm-config/dist/openmrs-esm-module-config.js 7.87 kB
packages/framework/esm-dynamic-loading/dist/openmrs-esm-dynamic-loading.js 2.12 kB
packages/framework/esm-error-handling/dist/openmrs-esm-error-handling.js 894 B
packages/framework/esm-extensions/dist/openmrs-esm-extensions.js 8.02 kB
packages/framework/esm-feature-flags/dist/openmrs-esm-feature-flags.js 1.67 kB
packages/framework/esm-framework/dist/530.openmrs-esm-framework.js 2.92 kB
packages/framework/esm-framework/dist/645.openmrs-esm-framework.js 9.31 kB
packages/framework/esm-framework/dist/710.openmrs-esm-framework.js 6.48 kB
packages/framework/esm-framework/dist/735.openmrs-esm-framework.js 2.66 kB
packages/framework/esm-framework/dist/788.openmrs-esm-framework.js 42.9 kB
packages/framework/esm-framework/dist/925.openmrs-esm-framework.js 6.69 kB
packages/framework/esm-framework/dist/openmrs-esm-framework.js 171 kB
packages/framework/esm-globals/dist/openmrs-esm-globals.js 714 B
packages/framework/esm-offline/dist/openmrs-esm-offline.js 34.4 kB
packages/framework/esm-react-utils/dist/openmrs-esm-react-utils.js 18.6 kB
packages/framework/esm-state/dist/openmrs-esm-state.js 878 B
packages/framework/esm-styleguide/dist/openmrs-esm-styleguide.js 18.4 kB
packages/framework/esm-utils/dist/openmrs-esm-utils.js 10.2 kB
packages/shell/esm-app-shell/dist/9894b1727d6bd536.js 1.58 kB
packages/shell/esm-app-shell/dist/e861b352d93d75e6.js 9.88 kB
packages/shell/esm-app-shell/dist/f816828deffc671b.js 6.02 kB
packages/shell/esm-app-shell/dist/openmrs.ad09a58550d1a15a.js 211 kB
packages/shell/esm-app-shell/dist/service-worker.js 57.3 kB
packages/tooling/openmrs/dist/cli.js 3.08 kB
packages/tooling/openmrs/dist/commands/assemble.js 2.73 kB
packages/tooling/openmrs/dist/commands/build.js 1.61 kB
packages/tooling/openmrs/dist/commands/debug.js 579 B
packages/tooling/openmrs/dist/commands/develop.js 1.84 kB
packages/tooling/openmrs/dist/commands/index.js 438 B
packages/tooling/openmrs/dist/commands/start.js 848 B
packages/tooling/openmrs/dist/index.js 517 B
packages/tooling/openmrs/dist/runner.js 870 B
packages/tooling/openmrs/dist/utils/config.js 726 B
packages/tooling/openmrs/dist/utils/debugger.js 529 B
packages/tooling/openmrs/dist/utils/dependencies.js 639 B
packages/tooling/openmrs/dist/utils/helpers.js 393 B
packages/tooling/openmrs/dist/utils/importmap.js 3.25 kB
packages/tooling/openmrs/dist/utils/index.js 444 B
packages/tooling/openmrs/dist/utils/logger.js 234 B
packages/tooling/openmrs/dist/utils/npmConfig.js 854 B
packages/tooling/openmrs/dist/utils/untar.js 721 B
packages/tooling/openmrs/dist/utils/variables.js 192 B
packages/tooling/openmrs/dist/utils/webpack.js 276 B
packages/tooling/webpack-config/dist/index.js 3.24 kB

compressed-size-action

@ibacher ibacher changed the title (improvement) Update type LoggedInUser to list userProperties in use (feat) Update type LoggedInUser to list userProperties in use Aug 10, 2023
@@ -13,7 +13,23 @@ export interface LoggedInUser {
display: string;
username: string;
systemId: string;
userProperties: { [key: string]: any } | null;
userProperties: {
Copy link
Member

Choose a reason for hiding this comment

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

So, the one thing I'm noticing is that these comments for named properties don't appear in the autogenerated docs, which is a bit unfortunate, but this is overall a big improvement.

userProperties: {
/**
* The UUIDs of patients the user has visited
* Seprataed by commas
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Seprataed by commas
* Separated by commas

patientsVisited?: string;
/**
* The UUIDs of patient lists the user has starred
* Seprataed by commas
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Seprataed by commas
* Separated by commas

@denniskigen denniskigen merged commit 68c5b67 into main Aug 10, 2023
6 checks passed
@denniskigen denniskigen deleted the update-user-props branch August 10, 2023 20:15
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