feat: upgrade to ArcGIS REST JS 4 by tomwayson · Pull Request #1850 · Esri/hub.js

tomwayson · 2025-03-28T20:47:49Z

Description:

TODO: before merging this, we must update the hub-common peer dependency to 17 in all packages, see below.

upgrade to ArcGIS REST JS 4

Instructions for testing:

pull
npm i
npm run lint && npm run build
npm test
npm run e2e:node

NOTE: node tests will be fixed in a future PR, see comment below.

Closes Issues: https://devtopia.esri.com/dc/hub/issues/10768
Updated meaningful TSDoc to methods including Parameters and Returns, see Documentation Guide
used semantic commit messages
PR title follows semantic commit format (CRITICAL if the title is not in a semantic format, the release automation will not run!)
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.

TODO: we need one more commit to do this before merging

package.json

affects: @esri/hub-common BREAKING CHANGE: UserSession -> ArcGISIdentityManager

affects: @esri/hub-downloads BREAKING CHANGE: UserSession -> ArcGISIdentityManager

affects: @esri/hub-events BREAKING CHANGE: UserSession -> ArcGISIdentityManager

affects: @esri/hub-initiatives BREAKING CHANGE: UserSession -> ArcGISIdentityManager

affects: @esri/hub-search BREAKING CHANGE: UserSession -> ArcGISIdentityManager

affects: @esri/hub-sites BREAKING CHANGE: UserSession -> ArcGISIdentityManager

affects: @esri/hub-surveys BREAKING CHANGE: UserSession -> ArcGISIdentityManager

affects: @esri/hub-teams BREAKING CHANGE: UserSession -> ArcGISIdentityManager

codecov · 2025-04-04T14:57:47Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (326925d) to head (2d31ba2).
Report is 23 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #1850   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files         1061      1061           
  Lines        19206     19207    +1     
  Branches      3493      3493           
=========================================
+ Hits         19206     19207    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2025-04-08T13:33:40Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

github-actions · 2025-04-14T13:34:15Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

affects: @esri/hub-common :wq

BREAKING CHANGE: ArcGIS REST JS peer dependencies must be v4

# @esri/hub-downloads [17.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-downloads@16.0.0...@esri/hub-downloads@17.0.0) (2025-04-22) ### Features * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4 ### Dependencies * **@esri/hub-common:** upgraded to 17.0.0

# [17.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-common@16.6.0...@esri/hub-common@17.0.0) (2025-04-22) ### Features * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4

# [17.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-events@16.0.0...@esri/hub-events@17.0.0) (2025-04-22) ### Bug Fixes * adds isOnlyWhitespace format to collectionschema ([#1860](#1860)) ([43a07ff](43a07ff)) * case insensitive subdomain comparison ([#1872](#1872)) ([ec5ae45](ec5ae45)) * enable "Add content" in project featured content ([#1857](#1857)) ([64070a4](64070a4)) * removed unused layout options in catalog schema ([#1855](#1855)) ([326925d](326925d)) * removed unused layout options in catalog schema ([#1851](#1851)) ([2ff71e0](2ff71e0)) * show all collection facets for project featured content and action links ([#1861](#1861)) ([3e884df](3e884df)) * site event catalog gating ([#1865](#1865)) ([c704b37](c704b37)) * **hub-common:** simplify the filter processing logic for events 3 wh… ([#1862](#1862)) ([7d87b7c](7d87b7c)) * update site now uses fetch site model ([#1859](#1859)) ([90f1b11](90f1b11)) * update slug validation rules ([#1858](#1858)) ([be2150f](be2150f)) * **hub-common:** update "hub:site:workspace:catalog:events" permission to include license checks ([#1849](#1849)) ([fabc8e7](fabc8e7)) ### Features * add hub-premium gating to hub:feature:catalogs:edit:advanced permission ([#1854](#1854)) ([4f2ee37](4f2ee37)) * add new Text UiSchemaElementType ([#1856](#1856)) ([2b5b125](2b5b125)) * add well-known group and event catalogs ([#1871](#1871)) ([3cf57e0](3cf57e0)) * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) * **hub-common:** add entity discussion settings ui schema ([#1852](#1852)) ([878b482](878b482)) * **hub-common:** add updatedAtAfter and updatedAtBefore to interface… ([#1864](#1864)) ([02d955b](02d955b)) * **hub-common:** search events download as csv ([#1846](#1846)) ([ef72381](ef72381)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4

# [17.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-initiatives@16.0.0...@esri/hub-initiatives@17.0.0) (2025-04-22) ### Bug Fixes * adds isOnlyWhitespace format to collectionschema ([#1860](#1860)) ([43a07ff](43a07ff)) * case insensitive subdomain comparison ([#1872](#1872)) ([ec5ae45](ec5ae45)) * enable "Add content" in project featured content ([#1857](#1857)) ([64070a4](64070a4)) * removed unused layout options in catalog schema ([#1855](#1855)) ([326925d](326925d)) * removed unused layout options in catalog schema ([#1851](#1851)) ([2ff71e0](2ff71e0)) * show all collection facets for project featured content and action links ([#1861](#1861)) ([3e884df](3e884df)) * site event catalog gating ([#1865](#1865)) ([c704b37](c704b37)) * **hub-common:** simplify the filter processing logic for events 3 wh… ([#1862](#1862)) ([7d87b7c](7d87b7c)) * update site now uses fetch site model ([#1859](#1859)) ([90f1b11](90f1b11)) * update slug validation rules ([#1858](#1858)) ([be2150f](be2150f)) * **hub-common:** update "hub:site:workspace:catalog:events" permission to include license checks ([#1849](#1849)) ([fabc8e7](fabc8e7)) ### Features * add hub-premium gating to hub:feature:catalogs:edit:advanced permission ([#1854](#1854)) ([4f2ee37](4f2ee37)) * add new Text UiSchemaElementType ([#1856](#1856)) ([2b5b125](2b5b125)) * add well-known group and event catalogs ([#1871](#1871)) ([3cf57e0](3cf57e0)) * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) * **hub-common:** add entity discussion settings ui schema ([#1852](#1852)) ([878b482](878b482)) * **hub-common:** add updatedAtAfter and updatedAtBefore to interface… ([#1864](#1864)) ([02d955b](02d955b)) * **hub-common:** search events download as csv ([#1846](#1846)) ([ef72381](ef72381)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4

# [17.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-search@16.0.0...@esri/hub-search@17.0.0) (2025-04-22) ### Bug Fixes * adds isOnlyWhitespace format to collectionschema ([#1860](#1860)) ([43a07ff](43a07ff)) * case insensitive subdomain comparison ([#1872](#1872)) ([ec5ae45](ec5ae45)) * enable "Add content" in project featured content ([#1857](#1857)) ([64070a4](64070a4)) * removed unused layout options in catalog schema ([#1855](#1855)) ([326925d](326925d)) * removed unused layout options in catalog schema ([#1851](#1851)) ([2ff71e0](2ff71e0)) * show all collection facets for project featured content and action links ([#1861](#1861)) ([3e884df](3e884df)) * site event catalog gating ([#1865](#1865)) ([c704b37](c704b37)) * **hub-common:** simplify the filter processing logic for events 3 wh… ([#1862](#1862)) ([7d87b7c](7d87b7c)) * update site now uses fetch site model ([#1859](#1859)) ([90f1b11](90f1b11)) * update slug validation rules ([#1858](#1858)) ([be2150f](be2150f)) * **hub-common:** update "hub:site:workspace:catalog:events" permission to include license checks ([#1849](#1849)) ([fabc8e7](fabc8e7)) ### Features * add hub-premium gating to hub:feature:catalogs:edit:advanced permission ([#1854](#1854)) ([4f2ee37](4f2ee37)) * add new Text UiSchemaElementType ([#1856](#1856)) ([2b5b125](2b5b125)) * add well-known group and event catalogs ([#1871](#1871)) ([3cf57e0](3cf57e0)) * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) * **hub-common:** add entity discussion settings ui schema ([#1852](#1852)) ([878b482](878b482)) * **hub-common:** add updatedAtAfter and updatedAtBefore to interface… ([#1864](#1864)) ([02d955b](02d955b)) * **hub-common:** search events download as csv ([#1846](#1846)) ([ef72381](ef72381)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4

# [18.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-sites@17.0.0...@esri/hub-sites@18.0.0) (2025-04-22) ### Bug Fixes * adds isOnlyWhitespace format to collectionschema ([#1860](#1860)) ([43a07ff](43a07ff)) * case insensitive subdomain comparison ([#1872](#1872)) ([ec5ae45](ec5ae45)) * enable "Add content" in project featured content ([#1857](#1857)) ([64070a4](64070a4)) * removed unused layout options in catalog schema ([#1855](#1855)) ([326925d](326925d)) * removed unused layout options in catalog schema ([#1851](#1851)) ([2ff71e0](2ff71e0)) * show all collection facets for project featured content and action links ([#1861](#1861)) ([3e884df](3e884df)) * site event catalog gating ([#1865](#1865)) ([c704b37](c704b37)) * **hub-common:** simplify the filter processing logic for events 3 wh… ([#1862](#1862)) ([7d87b7c](7d87b7c)) * update site now uses fetch site model ([#1859](#1859)) ([90f1b11](90f1b11)) * update slug validation rules ([#1858](#1858)) ([be2150f](be2150f)) * **hub-common:** update "hub:site:workspace:catalog:events" permission to include license checks ([#1849](#1849)) ([fabc8e7](fabc8e7)) ### Features * add hub-premium gating to hub:feature:catalogs:edit:advanced permission ([#1854](#1854)) ([4f2ee37](4f2ee37)) * add new Text UiSchemaElementType ([#1856](#1856)) ([2b5b125](2b5b125)) * add well-known group and event catalogs ([#1871](#1871)) ([3cf57e0](3cf57e0)) * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) * **hub-common:** add entity discussion settings ui schema ([#1852](#1852)) ([878b482](878b482)) * **hub-common:** add updatedAtAfter and updatedAtBefore to interface… ([#1864](#1864)) ([02d955b](02d955b)) * **hub-common:** search events download as csv ([#1846](#1846)) ([ef72381](ef72381)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4

# [17.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-surveys@16.0.0...@esri/hub-surveys@17.0.0) (2025-04-22) ### Bug Fixes * adds isOnlyWhitespace format to collectionschema ([#1860](#1860)) ([43a07ff](43a07ff)) * case insensitive subdomain comparison ([#1872](#1872)) ([ec5ae45](ec5ae45)) * enable "Add content" in project featured content ([#1857](#1857)) ([64070a4](64070a4)) * removed unused layout options in catalog schema ([#1855](#1855)) ([326925d](326925d)) * removed unused layout options in catalog schema ([#1851](#1851)) ([2ff71e0](2ff71e0)) * show all collection facets for project featured content and action links ([#1861](#1861)) ([3e884df](3e884df)) * site event catalog gating ([#1865](#1865)) ([c704b37](c704b37)) * **hub-common:** simplify the filter processing logic for events 3 wh… ([#1862](#1862)) ([7d87b7c](7d87b7c)) * update site now uses fetch site model ([#1859](#1859)) ([90f1b11](90f1b11)) * update slug validation rules ([#1858](#1858)) ([be2150f](be2150f)) * **hub-common:** update "hub:site:workspace:catalog:events" permission to include license checks ([#1849](#1849)) ([fabc8e7](fabc8e7)) ### Features * add hub-premium gating to hub:feature:catalogs:edit:advanced permission ([#1854](#1854)) ([4f2ee37](4f2ee37)) * add new Text UiSchemaElementType ([#1856](#1856)) ([2b5b125](2b5b125)) * add well-known group and event catalogs ([#1871](#1871)) ([3cf57e0](3cf57e0)) * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) * **hub-common:** add entity discussion settings ui schema ([#1852](#1852)) ([878b482](878b482)) * **hub-common:** add updatedAtAfter and updatedAtBefore to interface… ([#1864](#1864)) ([02d955b](02d955b)) * **hub-common:** search events download as csv ([#1846](#1846)) ([ef72381](ef72381)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4

# [17.0.0](https://github.com/Esri/hub.js/compare/@esri/hub-teams@16.0.0...@esri/hub-teams@17.0.0) (2025-04-22) ### Bug Fixes * adds isOnlyWhitespace format to collectionschema ([#1860](#1860)) ([43a07ff](43a07ff)) * case insensitive subdomain comparison ([#1872](#1872)) ([ec5ae45](ec5ae45)) * enable "Add content" in project featured content ([#1857](#1857)) ([64070a4](64070a4)) * removed unused layout options in catalog schema ([#1855](#1855)) ([326925d](326925d)) * removed unused layout options in catalog schema ([#1851](#1851)) ([2ff71e0](2ff71e0)) * show all collection facets for project featured content and action links ([#1861](#1861)) ([3e884df](3e884df)) * site event catalog gating ([#1865](#1865)) ([c704b37](c704b37)) * **hub-common:** simplify the filter processing logic for events 3 wh… ([#1862](#1862)) ([7d87b7c](7d87b7c)) * update site now uses fetch site model ([#1859](#1859)) ([90f1b11](90f1b11)) * update slug validation rules ([#1858](#1858)) ([be2150f](be2150f)) * **hub-common:** update "hub:site:workspace:catalog:events" permission to include license checks ([#1849](#1849)) ([fabc8e7](fabc8e7)) ### Features * add hub-premium gating to hub:feature:catalogs:edit:advanced permission ([#1854](#1854)) ([4f2ee37](4f2ee37)) * add new Text UiSchemaElementType ([#1856](#1856)) ([2b5b125](2b5b125)) * add well-known group and event catalogs ([#1871](#1871)) ([3cf57e0](3cf57e0)) * upgrade to ArcGIS REST JS 4 ([#1850](#1850)) ([8eb1496](8eb1496)) * **hub-common:** add entity discussion settings ui schema ([#1852](#1852)) ([878b482](878b482)) * **hub-common:** add updatedAtAfter and updatedAtBefore to interface… ([#1864](#1864)) ([02d955b](02d955b)) * **hub-common:** search events download as csv ([#1846](#1846)) ([ef72381](ef72381)) ### BREAKING CHANGES * ArcGIS REST JS peer dependencies must be v4

tomwayson commented Mar 28, 2025

View reviewed changes

package.json Show resolved Hide resolved

mjuniper approved these changes Mar 31, 2025

View reviewed changes

tomwayson force-pushed the f/rest-js-4 branch from 5fc744e to 1ae6dc4 Compare March 31, 2025 22:54

tomwayson added 11 commits April 4, 2025 07:42

chore: add script to update hub-common peer dep in all packages

007ec62

chore: install ArcGIS REST JS 4

0c9d683

chore: temporarily disable test:node due to \spyOn\ errors

ad8b7fa

feat(hub-common): upgrade to ArcGIS REST JS 4

82f27e8

affects: @esri/hub-common BREAKING CHANGE: UserSession -> ArcGISIdentityManager

feat(hub-downloads): upgrade to ArcGIS REST JS 4

33ffbce

affects: @esri/hub-downloads BREAKING CHANGE: UserSession -> ArcGISIdentityManager

feat(hub-events): upgrade to ArcGIS REST JS 4

48961d3

affects: @esri/hub-events BREAKING CHANGE: UserSession -> ArcGISIdentityManager

feat(hub-initiatives): upgrade to ArcGIS REST JS 4

c45a4d9

affects: @esri/hub-initiatives BREAKING CHANGE: UserSession -> ArcGISIdentityManager

feat(hub-search): upgrade to ArcGIS REST JS 4

b25ac78

affects: @esri/hub-search BREAKING CHANGE: UserSession -> ArcGISIdentityManager

feat(hub-sites): upgrade to REST JS 4

973fb83

affects: @esri/hub-sites BREAKING CHANGE: UserSession -> ArcGISIdentityManager

feat(hub-surveys): upgrade to REST JS 4

2189bf1

affects: @esri/hub-surveys BREAKING CHANGE: UserSession -> ArcGISIdentityManager

feat(hub-teams): upgrade to ArcGIS REST JS 4

2d31ba2

affects: @esri/hub-teams BREAKING CHANGE: UserSession -> ArcGISIdentityManager

tomwayson force-pushed the f/rest-js-4 branch from 1ae6dc4 to 2d31ba2 Compare April 4, 2025 14:50

github-actions bot added Stale Stale issue - update or it will be closed and removed Stale Stale issue - update or it will be closed labels Apr 8, 2025

github-actions bot added Stale Stale issue - update or it will be closed and removed Stale Stale issue - update or it will be closed labels Apr 14, 2025

tomwayson added 4 commits April 15, 2025 15:08

Merge branch 'master' into f/rest-js-4

3780ee9

Merge branch 'master' into f/rest-js-4

34d7490

Merge branch 'master' into f/rest-js-4

b71d0ad

test(hub-common): fix broken import

8660706

affects: @esri/hub-common :wq

tomwayson force-pushed the f/rest-js-4 branch from a31e990 to 8660706 Compare April 22, 2025 13:53

chore: update peerDependencies for release

b7c090c

tomwayson merged commit c264123 into master Apr 22, 2025
5 checks passed

tomwayson deleted the f/rest-js-4 branch April 22, 2025 14:11

tomwayson added a commit that referenced this pull request Apr 22, 2025

feat: upgrade to ArcGIS REST JS 4 (#1850)

8eb1496

BREAKING CHANGE: ArcGIS REST JS peer dependencies must be v4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

feat: upgrade to ArcGIS REST JS 4#1850

feat: upgrade to ArcGIS REST JS 4#1850
tomwayson merged 16 commits intomasterfrom
f/rest-js-4

tomwayson commented Mar 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

codecov bot commented Apr 4, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 8, 2025

Uh oh!

github-actions bot commented Apr 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

tomwayson commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Apr 8, 2025

Uh oh!

github-actions bot commented Apr 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tomwayson commented Mar 28, 2025 •

edited

Loading

codecov bot commented Apr 4, 2025 •

edited

Loading