Refactor/get layer signature

packages/arcgis-rest-feature-service/src/add.ts

@@ -3,13 +3,16 @@
 
 import {
   request,
-  IRequestOptions,
   cleanUrl,
   appendCustomParams,
   IFeature
 } from "@esri/arcgis-rest-request";
 
-import { IEditFeaturesParams, IEditFeatureResult } from "./helpers";
+import {
+  ILayerRequestOptions,
+  IEditFeaturesParams,
+  IEditFeatureResult
+} from "./helpers";
 
 /**
  * Add features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-features.htm) for more information.
@@ -20,11 +23,7 @@ import { IEditFeaturesParams, IEditFeatureResult } from "./helpers";
  */
 export interface IAddFeaturesRequestOptions
   extends IEditFeaturesParams,
-    IRequestOptions {
-  /**
-   * Feature service url.
-   */
-  url: string;
+    ILayerRequestOptions {
   /**
    * Array of JSON features to add.
    */

packages/arcgis-rest-feature-service/src/addAttachment.ts

@@ -1,18 +1,14 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { request, IRequestOptions, cleanUrl } from "@esri/arcgis-rest-request";
-import { IEditFeatureResult } from "./helpers";
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { ILayerRequestOptions, IEditFeatureResult } from "./helpers";
 
 /**
  * Request options for adding a related attachment to a feature by id. See [Add Attachment](https://developers.arcgis.com/rest/services-reference/add-attachment.htm) for more information.
  *
  */
-export interface IAddAttachmentOptions extends IRequestOptions {
-  /**
-   * Feature service url.
-   */
-  url: string;
+export interface IAddAttachmentOptions extends ILayerRequestOptions {
   /**
    * Unique identifier of feature to add related attachment.
    */

packages/arcgis-rest-feature-service/src/decodeValues.ts

@@ -66,7 +66,7 @@ export function decodeValues(
 ): Promise<IQueryFeaturesResponse> {
   return new Promise(resolve => {
     if (!requestOptions.fields) {
-      return getLayer(requestOptions.url, requestOptions).then(
+      return getLayer({ url: requestOptions.url }).then(
         (metadata: ILayerDefinition) => {
           resolve((requestOptions.fields = metadata.fields));
         }

packages/arcgis-rest-feature-service/src/delete.ts

@@ -3,11 +3,11 @@
 
 import {
   request,
-  IRequestOptions,
   cleanUrl,
   appendCustomParams
 } from "@esri/arcgis-rest-request";
 import {
+  ILayerRequestOptions,
   IEditFeaturesParams,
   IEditFeatureResult,
   ISharedQueryParams
@@ -29,11 +29,7 @@ export interface IDeleteFeaturesParams
  */
 export interface IDeleteFeaturesRequestOptions
   extends IDeleteFeaturesParams,
-    IRequestOptions {
-  /**
-   * Feature service url.
-   */
-  url: string;
+    ILayerRequestOptions {
   /**
    * Array of objectIds to delete.
    */

packages/arcgis-rest-feature-service/src/deleteAttachments.ts

@@ -1,18 +1,14 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { request, IRequestOptions, cleanUrl } from "@esri/arcgis-rest-request";
-import { IEditFeatureResult } from "./helpers";
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { ILayerRequestOptions, IEditFeatureResult } from "./helpers";
 
 /**
  * Request options to for deleting related attachments of a feature by id. See [Delete Attachments](https://developers.arcgis.com/rest/services-reference/delete-attachments.htm) for more information.
  *
  */
-export interface IDeleteAttachmentsOptions extends IRequestOptions {
-  /**
-   * Feature service url.
-   */
-  url: string;
+export interface IDeleteAttachmentsOptions extends ILayerRequestOptions {
   /**
    * Unique identifier of feature to delete related attachment(s).
    */

packages/arcgis-rest-feature-service/src/getAttachments.ts

@@ -1,17 +1,14 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { request, IRequestOptions, cleanUrl } from "@esri/arcgis-rest-request";
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { ILayerRequestOptions } from "./helpers";
 
 /**
  * Request options to fetch `attachmentInfos` of a feature by id. See [Attachment Infos](https://developers.arcgis.com/rest/services-reference/attachment-infos-feature-service-.htm) for more information.
  *
  */
-export interface IGetAttachmentsOptions extends IRequestOptions {
-  /**
-   * Feature service url.
-   */
-  url: string;
+export interface IGetAttachmentsOptions extends ILayerRequestOptions {
   /**
    * Unique identifier of feature to request related `attachmentInfos`.
    */

packages/arcgis-rest-feature-service/src/getLayer.ts

@@ -1,28 +1,24 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import {
-  request,
-  IRequestOptions,
-  cleanUrl,
-  ILayerDefinition
-} from "@esri/arcgis-rest-request";
-
+import { request, cleanUrl, ILayerDefinition } from "@esri/arcgis-rest-request";
+import { ILayerRequestOptions } from "./helpers";
 /**
  * ```js
  * import { getLayer } from '@esri/arcgis-rest-feature-service';
  * //
- * getLayer("https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0")
+ * getLayer({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0"
+ * })
  *   .then(response) // { name: "311", id: 0, ... }
  * ```
  * Layer (Feature Service) request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/layer-feature-service-.htm) for more information.
  *
- * @param requestOptions - Options for the request.
+ * @param options - Options for the request.
  * @returns A Promise that will resolve with the addFeatures response.
  */
 export function getLayer(
-  url: string,
-  requestOptions?: IRequestOptions
+  options: ILayerRequestOptions
 ): Promise<ILayerDefinition> {
-  return request(cleanUrl(url), requestOptions);
+  return request(cleanUrl(options.url), options);
 }

packages/arcgis-rest-feature-service/src/helpers.ts

@@ -5,9 +5,20 @@ import {
   GeometryType,
   SpatialRelationship,
   IGeometry,
-  ISpatialReference
+  ISpatialReference,
+  IRequestOptions
 } from "@esri/arcgis-rest-request";
 
+/**
+ * Base options for making requests against feature layers
+ */
+export interface ILayerRequestOptions extends IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url: string;
+}
+
 export interface ISharedQueryParams {
   where?: string;
   geometry?: IGeometry;

packages/arcgis-rest-feature-service/src/query.ts

@@ -3,7 +3,6 @@
 
 import {
   request,
-  IRequestOptions,
   cleanUrl,
   appendCustomParams,
   ISpatialReference,
@@ -13,16 +12,12 @@ import {
   IExtent
 } from "@esri/arcgis-rest-request";
 
-import { ISharedQueryParams } from "./helpers";
+import { ILayerRequestOptions, ISharedQueryParams } from "./helpers";
 
 /**
  * Request options to fetch a feature by id.
  */
-export interface IFeatureRequestOptions extends IRequestOptions {
-  /**
-   * Layer service url.
-   */
-  url: string;
+export interface IFeatureRequestOptions extends ILayerRequestOptions {
   /**
    * Unique identifier of the feature.
    */
@@ -49,11 +44,7 @@ export interface IStatisticDefinition {
  */
 export interface IQueryFeaturesRequestOptions
   extends ISharedQueryParams,
-    IRequestOptions {
-  /**
-   * Layer service url.
-   */
-  url: string;
+    ILayerRequestOptions {
   objectIds?: number[];
   relationParam?: string;
   // NOTE: either time=1199145600000 or time=1199145600000, 1230768000000

packages/arcgis-rest-feature-service/src/queryRelated.ts

@@ -3,7 +3,6 @@
 
 import {
   request,
-  IRequestOptions,
   cleanUrl,
   appendCustomParams,
   ISpatialReference,
@@ -12,12 +11,12 @@ import {
   GeometryType,
   IField
 } from "@esri/arcgis-rest-request";
+import { ILayerRequestOptions } from "./helpers";
 
 /**
  * Related record query request options. Additional arguments can be passed via the [params](/arcgis-rest-js/api/feature-service/IQueryRelatedRequestOptions/#params) property. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-related-feature-service-.htm) for more information and a full list of parameters.
  */
-export interface IQueryRelatedRequestOptions extends IRequestOptions {
-  url: string;
+export interface IQueryRelatedRequestOptions extends ILayerRequestOptions {
   relationshipId?: number;
   objectIds?: number[];
   outFields?: "*" | string[];

packages/arcgis-rest-feature-service/src/update.ts

@@ -3,13 +3,16 @@
 
 import {
   request,
-  IRequestOptions,
   cleanUrl,
   appendCustomParams,
   IFeature
 } from "@esri/arcgis-rest-request";
 
-import { IEditFeaturesParams, IEditFeatureResult } from "./helpers";
+import {
+  ILayerRequestOptions,
+  IEditFeaturesParams,
+  IEditFeatureResult
+} from "./helpers";
 
 /**
  * Update features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-features.htm) for more information.
@@ -20,11 +23,7 @@ import { IEditFeaturesParams, IEditFeatureResult } from "./helpers";
  */
 export interface IUpdateFeaturesRequestOptions
   extends IEditFeaturesParams,
-    IRequestOptions {
-  /**
-   * Feature service url.
-   */
-  url: string;
+    ILayerRequestOptions {
   /**
    * Array of JSON features to update.
    */

packages/arcgis-rest-feature-service/src/updateAttachment.ts

@@ -1,18 +1,14 @@
 /* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
  * Apache-2.0 */
 
-import { request, IRequestOptions, cleanUrl } from "@esri/arcgis-rest-request";
-import { IEditFeatureResult } from "./helpers";
+import { request, cleanUrl } from "@esri/arcgis-rest-request";
+import { ILayerRequestOptions, IEditFeatureResult } from "./helpers";
 
 /**
  * Request options to for updating a related attachment to a feature by id. See [Update Attachment](https://developers.arcgis.com/rest/services-reference/update-attachment.htm) for more information.
  *
  */
-export interface IUpdateAttachmentOptions extends IRequestOptions {
-  /**
-   * Feature service url.
-   */
-  url: string;
+export interface IUpdateAttachmentOptions extends ILayerRequestOptions {
   /**
    * Unique identifier of feature to update related attachment.
    */

packages/arcgis-rest-feature-service/test/getLayer.test.ts

@@ -15,7 +15,7 @@ describe("feature", () => {
 
   it("should fetch service metadata", done => {
     fetchMock.once("*", getFeatureServiceResponse);
-    getLayer(layerUrl)
+    getLayer({ url: layerUrl })
       .then(response => {
         expect(fetchMock.called()).toBeTruthy();
         const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");