4.0.0 Changelog

[patrickarlt]

4.0.0 is coming up this discussion is to collect all the major changes ahead of Dev Summit.

Bundling and Module Updates

• Polyfills for fetch and FormData are now managed and provided by ArcGIS REST JS in Node. Overriding the version of fetch used is now no longer supported. This is to prepare for the arrival of fetch in Node core.
• Support for importing ArcGIS REST JS as ESM modules in Node JS is now supported.
• Support for ArcGIS REST JS as ESM modules over a CDN is now supported through SkyPack

Version Updates and Supported Platforms

• Node 12.20 is now required to both use and build ArcGIS REST JS.
• ArcGIS REST JS is now compiled with TypeScript 4. If you are compiling a project with TypeScript that uses ArcGIS REST JS it is also recommended that you use TypeScript 4.
• Internet Explorer and Edge Legacy (Pre-Chromeium Edge) are no longer supported.
• Moving forward we will share the same supported browsers as the JS API and LTS versions of Node.

Package Consolidation

Several changes have been made to reduce the number of packages we publish as a part of ArcGIS REST JS and simplify our peer dependency story.

• The @esri/arcgis-rest-auth package has been merged into @esri/arcgis-rest-request. This was done to reduce complexity with peer dependencies and to reduce the overall number of packages. Methods in @esri/arcgis-rest-auth have also been renamed. See the authentication changes below.
• The @esri/arcgis-rest-service-admin package has been merged into @esri/arcgis-rest-feature-service and removed. To migrate your applications simply change any imports from @esri/arcgis-rest-service-admin to @esri/arcgis-rest-feature-service.
• @esri/arcgis-rest-types has been removed. Most types are now exported from the packages they are used in. If a specific type is used across multiple packages it is now available from @esri/arcgis-rest-request.

Authentication Changes

• The UserSession, ApiKey and ApplicationCredentials classes have been renamed to better correspond with the authentication methods in the documentation:

  • UserSession is now ArcGISIdentityManager
  • ApiKey is now ApiKeyManager
  • ApplicationCredentials is now ApplicationCredentialsManager

  When combined with the package consolidation changes your applications can import the new classes from @esri/arcgis-rest-request:

  - import { UserSession } from "@esri/arcgis-rest-auth"
  + import { ArcGISIdentityManager } from "@esri/arcgis-rest-request"

  - import { ApiKey } from "@esri/arcgis-rest-auth"
  + import { ApiKeyManager } from "@esri/arcgis-rest-request"

  - import { ApplicationCredentials } from "@esri/arcgis-rest-auth"
  + import { ApplicationCredentialsManager } from "@esri/arcgis-rest-request"

• Added a ArcGISIdentityManager.canRefresh getter which will tell you if the session can be refreshed or not.

• Added ArcGISIdentityManager.destroy() which will expire all tokens related to a session. ALso adds a revokeToken helper for manually expiring tokens in specific scenarios.

• Creating any of the main authentication classes should now be done with the factory methods. This is accomplished by adding several new static methods to classes in addition to existing methods like ArcGISIdentityManager.authorize() and ArcGISIdentityManager.beginOauth2():

  • ApiKeyManager.fromKey()
  • ApplicationCredentialsManager.fromCredentials()
  • ArcGISIdentityManager.fromToken()
  • ArcGISIdentityManager.signIn()

• Passing a string directly to authentication is now supported however it is still recommended to use one of the built in authentication mangers.