Skip to content

Update references to Umbraco User model (Extension Template) #19349

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Rockerby
Copy link
Contributor

@Rockerby Rockerby commented May 17, 2025

Correct the type definition for the user in the extension template dashboard.

Prerequisites

  • I have added steps to test this contribution in the description below

Linked issue - #19351

Description

Testing the extensions template with the v16 RC2 lead to issues in the dashboard. This PR corrects the types and a "possibly null" issue on the _contextCurrentUser object.

To see the original error you can run the below:

# Create an empty SLN
dotnet new sln --name MySite

# Install latest template
dotnet new install Umbraco.Templates::16.0.0-rc2

# Create a new Umbraco site of 16.0.0-rc2
dotnet new umbraco --name MySite

# Add project to SLN
dotnet sln add MySite

# Change into directory & run
# Go through installer
cd MySite
dotnet run

# Jump out one folder
cd ..

# Run extension template - make note of URL from dotnet run of site
dotnet new umbraco-extension --name MySite.Extensions --include-example --site-domain https://localhost:44348

# Add project to SLN
dotnet sln add MySite.Extensions 

# Add project reference
dotnet add MySite reference MySite.Extensions 

I needed to manually update the Umbraco version references in both the package.json (in the MySite.Extensions\Client folder) and the Umbraco version in the MySite.Extensions.csproj to point to v16 RC.

After building I then got the following errors:

src/dashboards/dashboard.element.ts:42:9 - error TS18048: 'currentUserContext' is possibly 'undefined'.
src/dashboards/dashboard.element.ts:44:11 - error TS2740: Type 'UmbCurrentUserModel' is missing the following properties from type 'UmbCurrentUserContext': #private, currentUser, load, isUserCurrentUser, and 36 more.

@warrenbuckley - thanks for the help with testing :)

In the template dashboard, update the type reference for the umbraco user
Copy link

github-actions bot commented May 17, 2025

Hi there @Rockerby, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

@emmagarland
Copy link
Contributor

Hi @Rockerby!

Thanks for your PR to correct the type definition for the user in the extension template dashboard in v16.

One of the Core Collaborators team will review this as soon as possible.

In the meantime if you have a logged issue that we could reference please let me know.

Thanks again, and for the useful replication steps.

Best wishes
Emma

@Rockerby
Copy link
Contributor Author

Cheers @emmagarland - I hadn't created an issue, but that makes it sound like you want one 😄

Ive created it here - #19351

@emmagarland
Copy link
Contributor

Fantastic, thanks @Rockerby !

Emma

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.

2 participants