Remove `rawResponse` support from REST JS packages by dixonyant · Pull Request #1326 · Esri/arcgis-rest-js

dixonyant · 2026-06-26T18:29:30Z

Description

This PR propagates the recent rawResponse deprecation changes across the library. rawResponse is no longer supported in requestOptions in request() and users must now use rawRequest() to get native responses.
This PR also updates the library to use the new IRequestOptions shape fetchOptions object instead of legacy properties.

This change will allow for consistent and guaranteed return types across any wrapper functions that call request. This change also guarantees that all request responses return as json. This PR drops support for requestOptions.rawResponse across REST JS.

Users will be able to get native responses through raw versions of wrapper methods like getItemDataRaw() or queryFeaturesRaw() and parse the response themselves. Format params that are not json (like f=pbf or binary return types like blob or text) will need to use methods that wrap rawRequest() and support those format types separately.

Breaking Changes

Query

getFeature() no longer supports raw response.
queryFeatures() can no longer be used to query features as pbf with f=pbf.

Geocode

bulkGeocode() no longer supports raw response.
geocode() no longer supports raw response.

Get

getItemData() no longer supports raw, file, or binary responses, use getItemDataRaw()instead.
deprecated IItemDataOptions since we don't support the file property in getItemData() anymore. Use getItemDataRaw() to get the native response instead.
getItemInfo() no longer supports rawResponse as an option and uses rawRequest() as default behavior.
getItemResource() no longer supports rawResponse as an option and uses rawRequest() as default behavior.

Added Behavior

Query

Added queryFeaturesRaw() to allow users to query features as a raw response and use format params including f=pbf or non-json types.

Get

Added getItemDataRaw() to allow users to handle non-json data manually.

Introduce `rawRequest()` to replace `rawResponse`

…options

…gn tests

previnWong · 2026-06-26T21:35:47Z

@dixonyant

Right now we have rawResponse as true in this case.

Request is imported from @esri/arcgis-rest-request

Do I need to update this? looks like I need to use rawRequest?

dixonyant

@patrickarlt i tagged each of the changes with the comments on the previous pr #1317 feedback, although there were more changes here. This pr should be the one that covers or finishes everything related to rawResponse for v5. most raw response support has been dropped except for queryFeaturesRaw() and getItemDataRaw() for now. Others can be added later with better typed support. processOptions and typed methods are coming next.

dixonyant · 2026-07-01T19:04:32Z

+    }
  };

-  if (options.file) {


Removing options.file here and deprecating the interface that uses it to resolve comment here: #1317 (comment)

they can use getItemDataRaw() and parse the response.blob() themselves

dixonyant · 2026-07-01T19:09:24Z

    }
  }

-  if (typeof address !== "string" && address.rawResponse) {


addresses #1317 (comment)

dixonyant · 2026-07-01T19:10:29Z

    );
  }

-  if (options.rawResponse) {


addresses #1317 (comment)

dixonyant · 2026-07-01T19:12:42Z

  /**
   * Response format. Defaults to "json"
-   * NOTE: for "pbf" you must use the method `rawRequest()`
+   * NOTE: for "f=pbf" you must use the method `queryFeaturesRaw()`


address feedback in #1317 (comment)

dixonyant · 2026-07-01T19:13:42Z

+      ...requestOptions.fetchOptions
+    }
  };
-  if (options.rawResponse) {


addresses #1317 (comment)

dixonyant · 2026-07-01T19:18:26Z

    queryOptions.params?.f === "pbf-as-arcgis"
  ) {
    return queryPbfAsGeoJSONOrArcGIS(requestOptions.url, queryOptions);
-  } else if (queryOptions.params?.f === "pbf") {


removing pbf from queryFeatures() to address #1317 (comment) and users can use queryFeaturesRaw() in the case they want to use a native response or native response with pbf

dixonyant · 2026-07-01T19:48:54Z

  objectIds?: number[];
 }

+export interface IQueryFeaturesRawOptions


pulling out this options construction code shared between queryFeatures and queryFeaturesRaw

dixonyant · 2026-07-01T19:54:43Z

      }
    );

+    queryOptions.fetchOptions = {


do we want to allow users to override or should this always be "GET" for query? @patrickarlt

dixonyant · 2026-07-01T19:54:51Z

    }
  );

+  options.fetchOptions = {


do we want to allow users to override or should this always be "GET" for queryRelated? @patrickarlt

dixonyant · 2026-07-01T20:25:37Z

+    expect(rawBuffer.byteLength).toBe(443);
+  });
+
+  test("queryFeatures with f=pbf should warn, but will query json and return typed json for f=pbf queries", async () => {


test case showing if users try and force a pbf request to request they will be warned as unsupported and will still get json

dixonyant · 2026-07-01T20:34:58Z

+    }
+  };
+
+  options.params.f = null;


leaving this here for functional equivalence. What about f=zip? https://developers.arcgis.com/rest/users-groups-and-items/item-data/

@patrickarlt

github-actions · 2026-07-01T21:13:24Z

Package	Line Rate	Branch Rate	Health
arcgis-rest-basemap-sessions.src	100%	100%	✔
arcgis-rest-basemap-sessions.src.utils	100%	100%	✔
arcgis-rest-demographics.src	100%	100%	✔
arcgis-rest-developer-credentials.src	100%	100%	✔
arcgis-rest-developer-credentials.src.shared	100%	100%	✔
arcgis-rest-elevation.src	100%	100%	✔
arcgis-rest-feature-service.src	100%	100%	✔
arcgis-rest-feature-service.src.pbf-parser	100%	100%	✔
arcgis-rest-geocoding.src	100%	100%	✔
arcgis-rest-places.src	100%	100%	✔
arcgis-rest-portal.src.groups	100%	100%	✔
arcgis-rest-portal.src.items	100%	100%	✔
arcgis-rest-portal.src.orgs	100%	100%	✔
arcgis-rest-portal.src.services	100%	100%	✔
arcgis-rest-portal.src.sharing	100%	100%	✔
arcgis-rest-portal.src.users	100%	100%	✔
arcgis-rest-portal.src.util	100%	100%	✔
arcgis-rest-request.src	100%	100%	✔
arcgis-rest-request.src.types	100%	100%	✔
arcgis-rest-request.src.utils	100%	100%	✔
arcgis-rest-routing.src	100%	100%	✔
Summary	100% (2484 / 2484)	100% (1327 / 1327)	✔

Minimum allowed line rate is 100%

dixonyant added 15 commits June 18, 2026 13:35

Merge pull request #1317 from Esri/rawrequest-replace-rawresponse

99b4b39

Introduce `rawRequest()` to replace `rawResponse`

wip remove rawResponse from packages

006b834

Merge branch 'appendCustomParams-update' into updatepackagestorequest…

4db15f5

…options

refactor(developer-credentials): migrate request method shape and ali…

711cec5

…gn tests

refactor(elevation): migrate request method shape

c08ddd2

refactor(feature-service): migrate request method shape and align tests

ab05b41

refactor(geocoding): migrate request method shape and align tests

ec5de03

refactor(places): migrate request method shape

2865073

refactor(portal): migrate request method shape and align tests

ddd4ba2

refactor(request): migrate request method shape

762af37

refactor(basemap-sessions): migrate request method shape

b6dea54

remove raw geocode

ead9c35

remove raw bulk geocode

68c64f9

remove raw get feature

80b2f77

remove raw get item resource and info

a4f1ec2

dixonyant added 3 commits June 30, 2026 11:54

handle queryFeatures and queryFeaturesRaw

2e70e57

fix bulk test to test for error object instead of string

1ea4b0e

handle getItemData and getItemDataRaw

1a8f3e5

dixonyant marked this pull request as ready for review June 30, 2026 23:13

dixonyant changed the base branch from v5.0.0 to main June 30, 2026 23:23

dixonyant changed the base branch from main to v5.0.0 June 30, 2026 23:23

dixonyant changed the base branch from v5.0.0 to appendCustomParams-update June 30, 2026 23:24

dixonyant requested a review from patrickarlt July 1, 2026 15:35

adjust spread order and consolidate http method sets

17f88cb

dixonyant mentioned this pull request Jul 1, 2026

Introduce rawRequest() to replace rawResponse #1317

Merged

dixonyant commented Jul 1, 2026

View reviewed changes

dixonyant added 2 commits July 1, 2026 13:59

make method change disallow more explicit

1ac926c

found two more

b694710

Uh oh!

Conversation

dixonyant commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Breaking Changes

Added Behavior

Uh oh!

previnWong commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dixonyant left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dixonyant Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dixonyant Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jul 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dixonyant commented Jun 26, 2026 •

edited

Loading

previnWong commented Jun 26, 2026 •

edited

Loading

dixonyant Jul 1, 2026 •

edited

Loading

dixonyant Jul 1, 2026 •

edited

Loading