feat: EntityEditor class

[dbouwman]

1. Description:

2. Instructions for testing:

• run tests
• pull opendata-ui branch ADD BRANCH
• build and copy output into
  • ~/projects/opendata-ui/packages/hub-components/node_modules/@esri/hub-common
  • ~/projects/opendata-ui/node_modules/@esri/hub-common
• start harness app yarn hc start
• use project workspace harness to verify editing

1. Closes Issues: 7183

2. Updated meaningful TSDoc to methods including Parameters and Returns, see Documentation Guide

3. used semantic commit messages

4. PR title follows semantic commit format (CRITICAL if the title is not in a semantic format, the release automation will not run!)

5. updated peerDependencies as needed. CRITICAL our automated release system can not be counted on to update peerDependencies so we must do it manually in our PRs when needed. See the updating peerDependencies section of the release instructions for more details.

[juliannemarik]

This is all looking really good to me! Left some minor comments. I think getting this logic hoisted over will be extremely helpful as teams start scaffolding their settings panes to include entity-specific editing experiences as well

[juliannemarik]

I think this is a good question, and generally speaking, I feel like it would be nice to make this util more generic/less featured-image-specific. I just ran into needing similar functionality with Aaron who's trying to hook up editing an item's thumbnail. The differences there are:

1. the url lives at entity.thumbnailUrl
2. entity.thumbnailUrl already has the token appended to it

So not entirely sure how to make this generic to work in both cases, but you could do something like:

getImageUrl (
  url: string,
  context?: IArcGISContext // make this optional if you want to append the token
) {
  const queryParams = context?.isAuthenticated
      ? `?token=${context.session.token}`
      : "";

  return cacheBustUrl(`${url}${queryParams}`);
}

[dbouwman]

I agree - I'll make an issue to try to resolve this - I don't want to add additional concerns / refactors to this PR

[juliannemarik]

I don't think extent needs to be here anymore?

[dbouwman]

I remove it, and verified in the harness...

[juliannemarik]

Similar to what we just did with creating a base IHubItemEntitySchema that all entities can spread, I think it might be nice to create a baseItemEntityConfigOptions array that all item entities can spread because I don't think any of this is necessarily project-specific.

[dbouwman]

Let's revisit this on a subsequent PR / issue

[codecov]

Codecov Report

Merging #1127 (e24f1c6) into master (3c7ab72) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##            master     #1127    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files          692       702    +10     
  Lines        11971     12130   +159     
  Branches      2013      2047    +34     
==========================================
+ Hits         11971     12130   +159     

Impacted Files	Coverage Δ
packages/common/src/core/index.ts	100.00% <ø> (ø)
packages/common/src/core/schemas/types.ts	100.00% <ø> (ø)
packages/common/src/core/types/IHubProject.ts	100.00% <ø> (ø)
...mon/src/projects/_internal/ProjectBusinessRules.ts	100.00% <ø> (ø)
...on/src/projects/_internal/ProjectUiSchemaCreate.ts	100.00% <ø> (ø)
packages/common/src/core/EntityEditor.ts	100.00% <100.00%> (ø)
packages/common/src/core/HubItemEntity.ts	100.00% <100.00%> (ø)
.../common/src/core/schemas/getEntityEditorSchemas.ts	100.00% <100.00%> (ø)
...mmon/src/core/schemas/internal/getCategoryItems.ts	100.00% <100.00%> (ø)
...ore/schemas/internal/getFeaturedContentCatalogs.ts	100.00% <100.00%> (ø)
... and 12 more

[dbouwman]

Follow on issues;

• https://devtopia.esri.com/dc/hub/issues/7362
• https://devtopia.esri.com/dc/hub/issues/7363

[juliannemarik]

awesome! Looking forward to using this