use new appendCustomParams consistently

Esri · Apr 16, 2019 · 99300a8 · 99300a8
1 parent eb297cb
commit 99300a8
Show file tree

Hide file tree

Showing 20 changed files with 172 additions and 241 deletions.
diff --git a/packages/arcgis-rest-common/package.json b/packages/arcgis-rest-common/package.json
@@ -13,6 +13,14 @@
     "dist/**"
   ],
   "dependencies": {
+    "tslib": "^1.9.3"
+  },
+
+  "devDependencies": {
+    "tslib": "^1.9.3",
+    "@esri/arcgis-rest-request": "^1.19.2"
+  },
+  "peerDependencies": {
     "tslib": "^1.9.3",
     "@esri/arcgis-rest-request": "^1.19.2"
   },

diff --git a/packages/arcgis-rest-common/src/util/append-custom-params.ts b/packages/arcgis-rest-common/src/util/append-custom-params.ts
@@ -30,7 +30,9 @@ export function appendCustomParams<T extends IRequestOptions>(
 
   // merge all keys in customOptions into options.params
   options.params = keys.reduce((value, key) => {
-    value[key as any] = customOptions[key];
+    if (customOptions[key] || typeof customOptions[key] === "boolean") {
+      value[key as any] = customOptions[key];
+    }
     return value;
   }, options.params);
 

diff --git a/packages/arcgis-rest-feature-service/package.json b/packages/arcgis-rest-feature-service/package.json
@@ -17,11 +17,13 @@
   },
   "devDependencies": {
     "@esri/arcgis-rest-common-types": "^1.19.2",
-    "@esri/arcgis-rest-request": "^1.19.2"
+    "@esri/arcgis-rest-request": "^1.19.2",
+    "@esri/arcgis-rest-common": "^1.19.2"
   },
   "peerDependencies": {
     "@esri/arcgis-rest-common-types": "^1.19.2",
-    "@esri/arcgis-rest-request": "^1.19.2"
+    "@esri/arcgis-rest-request": "^1.19.2",
+    "@esri/arcgis-rest-common": "^1.19.2"
   },
   "scripts": {
     "prepare": "npm run build",

diff --git a/packages/arcgis-rest-feature-service/src/add.ts b/packages/arcgis-rest-feature-service/src/add.ts
@@ -5,10 +5,11 @@ import { IFeature } from "@esri/arcgis-rest-common-types";
 import {
   request,
   IRequestOptions,
-  appendCustomParams,
   cleanUrl,
   warn
 } from "@esri/arcgis-rest-request";
+import { appendCustomParams } from "@esri/arcgis-rest-common";
+
 import { IEditFeaturesParams, IEditFeatureResult } from "./helpers";
 
 /**
@@ -69,21 +70,11 @@ export function addFeatures(
   const url = `${cleanUrl(requestOptions.url)}/addFeatures`;
 
   // edit operations are POST only
-  const options: IAddFeaturesRequestOptions = {
-    params: {},
-    ...requestOptions
-  };
-
-  appendCustomParams(requestOptions, options);
-
-  if (options.params.adds && options.params.adds.length) {
-    // mixin, don't overwrite
-    options.params.features = requestOptions.adds;
-    delete options.params.adds;
-    warn(
-      "The `adds` parameter is deprecated and will be removed in a future release. Please use `features` instead."
-    );
-  }
+  const options = appendCustomParams<IAddFeaturesRequestOptions>(
+    requestOptions,
+    ["features", "gdbVersion", "returnEditMoment", "rollbackOnFailure"],
+    { params: { ...requestOptions.params } }
+  );
 
   return request(url, options);
 }
diff --git a/packages/arcgis-rest-feature-service/src/delete.ts b/packages/arcgis-rest-feature-service/src/delete.ts
@@ -4,10 +4,10 @@
 import {
   request,
   IRequestOptions,
-  appendCustomParams,
   cleanUrl,
   warn
 } from "@esri/arcgis-rest-request";
+import { appendCustomParams } from "@esri/arcgis-rest-common";
 import {
   IEditFeaturesParams,
   IEditFeatureResult,
@@ -75,21 +75,17 @@ export function deleteFeatures(
   const url = `${cleanUrl(requestOptions.url)}/deleteFeatures`;
 
   // edit operations POST only
-  const options: IDeleteFeaturesRequestOptions = {
-    params: {},
-    ...requestOptions
-  };
-
-  appendCustomParams(requestOptions, options);
-
-  if (options.params.deletes && options.params.deletes.length) {
-    // mixin, don't overwrite
-    options.params.objectIds = requestOptions.deletes;
-    delete options.params.deletes;
-    warn(
-      "The `deletes` parameter is deprecated and will be removed in a future release. Please use `objectIds` instead."
-    );
-  }
+  const options = appendCustomParams<IDeleteFeaturesRequestOptions>(
+    requestOptions,
+    [
+      "where",
+      "objectIds",
+      "gdbVersion",
+      "returnEditMoment",
+      "rollbackOnFailure"
+    ],
+    { params: { ...requestOptions.params } }
+  );
 
   return request(url, options);
 }
diff --git a/packages/arcgis-rest-feature-service/src/helpers.ts b/packages/arcgis-rest-feature-service/src/helpers.ts
@@ -1,8 +1,6 @@
 /* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { appendCustomParams } from "@esri/arcgis-rest-request";
-
 import {
   esriGeometryType,
   SpatialRelationship,
@@ -45,6 +43,3 @@ export interface IEditFeaturesParams {
    */
   rollbackOnFailure?: boolean;
 }
-
-// this function has been moved into @esri/request. it is re-exported here for backwards compatibility
-export { appendCustomParams };
diff --git a/packages/arcgis-rest-feature-service/src/query.ts b/packages/arcgis-rest-feature-service/src/query.ts
@@ -1,12 +1,8 @@
 /* Copyright (c) 2017-2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import {
-  request,
-  IRequestOptions,
-  appendCustomParams,
-  cleanUrl
-} from "@esri/arcgis-rest-request";
+import { request, IRequestOptions, cleanUrl } from "@esri/arcgis-rest-request";
+import { appendCustomParams } from "@esri/arcgis-rest-common";
 import {
   ISpatialReference,
   IFeatureSet,
@@ -163,22 +159,51 @@ export function getFeature(
 export function queryFeatures(
   requestOptions: IQueryFeaturesRequestOptions
 ): Promise<IQueryFeaturesResponse | IQueryResponse> {
-  const queryOptions: IQueryFeaturesRequestOptions = {
-    params: {},
-    httpMethod: "GET",
-    url: requestOptions.url,
-    ...requestOptions
-  };
-
-  appendCustomParams(requestOptions, queryOptions);
-
-  // set default query parameters
-  if (!queryOptions.params.where) {
-    queryOptions.params.where = "1=1";
-  }
-  if (!queryOptions.params.outFields) {
-    queryOptions.params.outFields = "*";
-  }
+  const queryOptions = appendCustomParams<IQueryFeaturesRequestOptions>(
+    requestOptions,
+    [
+      "where",
+      "objectIds",
+      "relationParam",
+      "time",
+      "distance",
+      "units",
+      "outFields",
+      "returnGeometry",
+      "maxAllowableOffset",
+      "geometryPrecision",
+      "outSR",
+      "gdbVersion",
+      "returnDistinctValues",
+      "returnIdsOnly",
+      "returnCountOnly",
+      "returnExtentOnly",
+      "orderByFields",
+      "groupByFieldsForStatistics",
+      "outStatistics",
+      "returnZ",
+      "returnM",
+      "multipatchOption",
+      "resultOffset",
+      "resultRecordCount",
+      "quantizationParameters",
+      "returnCentroid",
+      "resultType",
+      "historicMoment",
+      "returnTrueCurves",
+      "sqlFormat",
+      "returnExceededLimitFeatures"
+    ],
+    {
+      httpMethod: "GET",
+      params: {
+        // set default query parameters
+        where: "1=1",
+        outFields: "*",
+        ...requestOptions.params
+      }
+    }
+  );
 
-  return request(`${cleanUrl(queryOptions.url)}/query`, queryOptions);
+  return request(`${cleanUrl(requestOptions.url)}/query`, queryOptions);
 }
diff --git a/packages/arcgis-rest-feature-service/src/queryRelated.ts b/packages/arcgis-rest-feature-service/src/queryRelated.ts
@@ -1,12 +1,8 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import {
-  request,
-  IRequestOptions,
-  appendCustomParams,
-  cleanUrl
-} from "@esri/arcgis-rest-request";
+import { request, IRequestOptions, cleanUrl } from "@esri/arcgis-rest-request";
+import { appendCustomParams } from "@esri/arcgis-rest-common";
 import {
   ISpatialReference,
   IFeature,
@@ -66,26 +62,23 @@ export interface IQueryRelatedResponse extends IHasZM {
 export function queryRelated(
   requestOptions: IQueryRelatedRequestOptions
 ): Promise<IQueryRelatedResponse> {
-  const options: IQueryRelatedRequestOptions = {
-    params: {},
-    httpMethod: "GET",
-    url: requestOptions.url,
-    ...requestOptions
-  };
-
-  appendCustomParams(requestOptions, options);
-
-  if (!options.params.definitionExpression) {
-    options.params.definitionExpression = "1=1";
-  }
-
-  if (!options.params.outFields) {
-    options.params.outFields = "*";
-  }
-
-  if (!options.params.relationshipId) {
-    options.params.relationshipId = 0;
-  }
+  const options = appendCustomParams<IQueryRelatedRequestOptions>(
+    requestOptions,
+    ["objectIds", "relationshipId", "definitionExpression", "outFields"],
+    {
+      httpMethod: "GET",
+      params: {
+        // set default query parameters
+        definitionExpression: "1=1",
+        outFields: "*",
+        relationshipId: 0,
+        ...requestOptions.params
+      }
+    }
+  );
 
-  return request(`${cleanUrl(options.url)}/queryRelatedRecords`, options);
+  return request(
+    `${cleanUrl(requestOptions.url)}/queryRelatedRecords`,
+    options
+  );
 }
diff --git a/packages/arcgis-rest-feature-service/src/update.ts b/packages/arcgis-rest-feature-service/src/update.ts
@@ -5,10 +5,10 @@ import { IFeature } from "@esri/arcgis-rest-common-types";
 import {
   request,
   IRequestOptions,
-  appendCustomParams,
   cleanUrl,
   warn
 } from "@esri/arcgis-rest-request";
+import { appendCustomParams } from "@esri/arcgis-rest-common";
 import { IEditFeaturesParams, IEditFeatureResult } from "./helpers";
 
 /**
@@ -69,21 +69,11 @@ export function updateFeatures(
   const url = `${cleanUrl(requestOptions.url)}/updateFeatures`;
 
   // edit operations are POST only
-  const options: IUpdateFeaturesRequestOptions = {
-    params: {},
-    ...requestOptions
-  };
-
-  appendCustomParams(requestOptions, options);
-
-  if (options.params.updates && options.params.updates.length) {
-    // mixin, don't overwrite
-    options.params.features = requestOptions.updates;
-    delete options.params.updates;
-    warn(
-      "The `updates` parameter is deprecated and will be removed in a future release. Please use `features` instead."
-    );
-  }
+  const options = appendCustomParams<IUpdateFeaturesRequestOptions>(
+    requestOptions,
+    ["features", "gdbVersion", "returnEditMoment", "rollbackOnFailure"],
+    { params: { ...requestOptions.params } }
+  );
 
   return request(url, options);
 }
diff --git a/packages/arcgis-rest-feature-service/test/crud.test.ts b/packages/arcgis-rest-feature-service/test/crud.test.ts
@@ -201,15 +201,6 @@ describe("feature", () => {
             Native: "YES"
           }
         }
-      ], // for linting
-      updates: [
-        {
-          attributes: {
-            OBJECTID: 1001,
-            Street: "NO",
-            Native: "YES"
-          }
-        }
       ],
       rollbackOnFailure: false
     } as IUpdateFeaturesRequestOptions;
@@ -238,7 +229,7 @@ describe("feature", () => {
   it("should return objectId of the deleted feature and a truthy success", done => {
     const requestOptions = {
       url: serviceUrl,
-      deletes: [1001],
+      objectIds: [1001],
       where: "1=1"
     } as IDeleteFeaturesRequestOptions;
     fetchMock.once("*", deleteFeaturesResponse);
@@ -251,7 +242,7 @@ describe("feature", () => {
         expect(options.body).toContain("where=1%3D1");
         expect(options.method).toBe("POST");
         expect(response.deleteResults[0].objectId).toEqual(
-          requestOptions.deletes[0]
+          requestOptions.objectIds[0]
         );
         expect(response.deleteResults[0].success).toEqual(true);
         done();

diff --git a/packages/arcgis-rest-geocoder/package.json b/packages/arcgis-rest-geocoder/package.json
@@ -18,11 +18,13 @@
   "devDependencies": {
     "@esri/arcgis-rest-auth": "^1.19.2",
     "@esri/arcgis-rest-common-types": "^1.19.2",
+    "@esri/arcgis-rest-common": "^1.19.2",
     "@esri/arcgis-rest-request": "^1.19.2"
   },
   "peerDependencies": {
     "@esri/arcgis-rest-auth": "^1.19.2",
     "@esri/arcgis-rest-common-types": "^1.19.2",
+    "@esri/arcgis-rest-common": "^1.19.2",
     "@esri/arcgis-rest-request": "^1.19.2"
   },
   "scripts": {