Merge pull request #1284 from Esri/add-deprecation-messages

Add deprecation tags and warnings

Author: dixonyant

.changeset/crisp-rockets-sing.md

@@ -0,0 +1,5 @@
+---
+"@esri/arcgis-rest-request": patch
+---
+
+Added deprecation messages for upcoming request package updates

package-lock.json

@@ -37,13 +37,15 @@ export const NODEJS_DEFAULT_REFERER_HEADER = `@esri/arcgis-rest-js`;
  *
  * You should **never** set a default `authentication` when you are in a server side environment where you may be handling requests for many different authenticated users.
  *
+ * @deprecated since v4.0.0.
  * @param options The default options to pass with every request. Existing default will be overwritten.
  * @param hideWarnings Silence warnings about setting default `authentication` in shared environments.
  */
 export function setDefaultRequestOptions(
   options: IRequestOptions,
   hideWarnings?: boolean
 ) {
+  console.warn(`setDefaultRequestOptions() is deprecated. This will be removed in ArcGIS REST JS v5.0.`);
   if (options.authentication && !hideWarnings) {
     warn(
       "You should not set `authentication` as a default in a shared environment such as a web server which will process multiple users requests. You can call `setDefaultRequestOptions` with `true` as a second argument to disable this warning."
@@ -502,6 +504,7 @@ export function internalRequest(
           });
       }
       if (rawResponse) {
+        console.warn(`rawResponse option is deprecated and will be removed in ArcGIS REST JS v5.0.`);
         return response;
       }
       switch (params.f) {

packages/arcgis-rest-request/src/request.ts

@@ -18,6 +18,7 @@ export interface IRequestOptions {
   httpMethod?: HTTPMethods;
   /**
    * Return the raw [response](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+   * @deprecated since v4.0.0.
    */
   rawResponse?: boolean;
   /**
@@ -65,6 +66,7 @@ export interface IRequestOptions {
 
   /**
    * Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).
+   * @deprecated since v4.0.0
    * @param requestOptions
    * @returns
    */

packages/arcgis-rest-request/src/utils/IRequestOptions.ts

@@ -22,7 +22,7 @@ import { IRequestOptions } from "../utils/IRequestOptions.js";
  *   where: "TRL_NAME LIKE '%backbone%'"
  * }).then(result);
  * ```
- *
+ * @deprecated since v4.0.0.
  * @param defaultOptions The options to pass into to the `func`.
  * @param func Any function that accepts anything extending `IRequestOptions` as its last parameter.
  * @returns A copy of `func` with the `defaultOptions` passed in as defaults.
@@ -34,6 +34,7 @@ export function withOptions<
   defaultOptions: IRequestOptions,
   func: T
 ): (...funcArgs: Parameters<T>) => ReturnType<T> {
+  console.warn(`withOptions() is deprecated. This will be removed in ArcGIS REST JS v5.0.`);
   return (...args: Parameters<T>): ReturnType<T> => {
     const options: K =
       typeof args[args.length - 1] === "object"