delectusnon 1.0.0

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

@@ -0,0 +1,172 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  ISpatialReference,
+  IFeatureSet,
+  IFeature,
+  esriUnits,
+  IExtent
+} from "@esri/arcgis-rest-common-types";
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+
+import { ISharedQueryParams, appendCustomParams } from "./helpers";
+/**
+ * Request options to fetch a feature by id.
+ */
+export interface IFeatureRequestOptions extends IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url: string;
+  /**
+   * Unique identifier of the feature.
+   */
+  id: number;
+}
+
+export interface IStatisticDefinition {
+  /**
+   * Statistical operation to perform (count, sum, min, max, avg, stddev, var).
+   */
+  statisticType: "count" | "sum" | "min" | "max" | "avg" | "stddev" | "var";
+  /**
+   * Field on which to perform the statistical operation.
+   */
+  onStatisticField: string;
+  /**
+   * Field name for the returned statistic field. If outStatisticFieldName is empty or missing, the server will assign one. A valid field name can only contain alphanumeric characters and an underscore. If the outStatisticFieldName is a reserved keyword of the underlying DBMS, the operation can fail. Try specifying an alternative outStatisticFieldName.
+   */
+  outStatisticFieldName: string;
+}
+
+/**
+ * feature query request options. See [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) for more information.
+ */
+export interface IQueryFeaturesRequestOptions
+  extends ISharedQueryParams,
+    IRequestOptions {
+  /**
+   * Layer service url.
+   */
+  url: string;
+  objectIds?: number[];
+  relationParam?: string;
+  // NOTE: either time=1199145600000 or time=1199145600000, 1230768000000
+  time?: number | number[];
+  distance?: number;
+  units?: esriUnits;
+  outFields?: "*" | string[];
+  returnGeometry?: boolean;
+  maxAllowableOffset?: number;
+  geometryPrecision?: number;
+  // NOTE: either WKID or ISpatialReference
+  outSR?: string | ISpatialReference;
+  gdbVersion?: string;
+  returnDistinctValues?: boolean;
+  returnIdsOnly?: boolean;
+  returnCountOnly?: boolean;
+  returnExtentOnly?: boolean;
+  orderByFields?: string;
+  groupByFieldsForStatistics?: string;
+  outStatistics?: IStatisticDefinition[];
+  returnZ?: boolean;
+  returnM?: boolean;
+  multipatchOption?: "xyFootprint";
+  resultOffset?: number;
+  resultRecordCount?: number;
+  // TODO: IQuantizationParameters?
+  quantizationParameters?: any;
+  returnCentroid?: boolean;
+  resultType?: "none" | "standard" | "tile";
+  // to do: convert from Date() to epoch time internally
+  historicMoment?: number;
+  returnTrueCurves?: false;
+  sqlFormat?: "none" | "standard" | "native";
+  returnExceededLimitFeatures?: boolean;
+}
+
+export interface IQueryFeaturesResponse extends IFeatureSet {
+  exceededTransferLimit?: boolean;
+}
+
+export interface IQueryResponse {
+  count?: number;
+  extent?: IExtent;
+  objectIdFieldName?: string;
+  objectIds?: number[];
+}
+
+/**
+ * Get a feature by id.
+ *
+ * ```js
+ * import { getFeature } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Landscape_Trees/FeatureServer/0";
+ *
+ * getFeature({
+ *   url,
+ *   id: 42
+ * }).then(feature => {
+ *  console.log(feature.attributes.FID); // 42
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the feature.
+ */
+export function getFeature(
+  requestOptions: IFeatureRequestOptions
+): Promise<IFeature> {
+  const url = `${requestOptions.url}/${requestOptions.id}`;
+
+  // default to a GET request
+  const options: IFeatureRequestOptions = {
+    ...{ httpMethod: "GET" },
+    ...requestOptions
+  };
+  return request(url, options).then((response: any) => response.feature);
+}
+
+/**
+ * Query a feature service. See [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-feature-service-layer-.htm) for more information.
+ *
+ * ```js
+ * import { queryFeatures } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3";
+ *
+ * queryFeatures({
+ *   url,
+ *   where: "STATE_NAME = 'Alaska"
+ * }).then(result => {
+ *   console.log(result.features); // array of features
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the query response.
+ */
+export function queryFeatures(
+  requestOptions: IQueryFeaturesRequestOptions
+): Promise<IQueryFeaturesResponse | IQueryResponse> {
+  // default to a GET request
+  const options: IQueryFeaturesRequestOptions = {
+    params: {},
+    httpMethod: "GET",
+    url: requestOptions.url,
+    ...requestOptions
+  };
+
+  appendCustomParams(requestOptions, options);
+
+  // set default query parameters
+  if (!options.params.where) {
+    options.params.where = "1=1";
+  }
+  if (!options.params.outFields) {
+    options.params.outFields = "*";
+  }
+  return request(`${options.url}/query`, options);
+}

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

@@ -0,0 +1,91 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import {
+  ISpatialReference,
+  IFeature,
+  IHasZM,
+  esriGeometryType,
+  IField
+} from "@esri/arcgis-rest-common-types";
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+import { appendCustomParams } 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;
+  relationshipId?: number;
+  objectIds?: number[];
+  outFields?: "*" | string[];
+  definitionExpression?: string;
+}
+
+/**
+ * Related record data structure
+ */
+
+export interface IRelatedRecordGroup {
+  objectId: number;
+  relatedRecords?: IFeature[];
+  count?: number;
+}
+
+/**
+ * Related record response structure
+ */
+
+export interface IQueryRelatedResponse extends IHasZM {
+  geometryType?: esriGeometryType;
+  spatialReference?: ISpatialReference;
+  fields?: IField[];
+  relatedRecordGroups: IRelatedRecordGroup[];
+}
+/**
+ * Query the related records for a feature service. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/query-related-records-feature-service-.htm) for more information.
+ *
+ * ```js
+ * import { queryRelated } from '@esri/arcgis-rest-feature-service'
+ *
+ * const url = "http://services.myserver/OrgID/ArcGIS/rest/services/Petroleum/KSPetro/FeatureServer/0"
+ *
+ * queryRelated({
+ *  url: url,
+ *  relationshipId: 1,
+ *  params: { returnCountOnly: true }
+ * })
+ *  .then(response => {
+ *    console.log(response.relatedRecords)
+ *  })
+ * ```
+ *
+ * @param requestOptions
+ * @returns A Promise that will resolve with the query response
+ */
+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;
+  }
+
+  return request(`${options.url}/queryRelatedRecords`, options);
+}

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

@@ -0,0 +1,81 @@
+/* Copyright (c) 2017 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { IFeature } from "@esri/arcgis-rest-common-types";
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+
+import {
+  IEditFeaturesParams,
+  IEditFeatureResult,
+  appendCustomParams
+} from "./helpers";
+
+/**
+ * Update features request options. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-features.htm) for more information.
+ *
+ * @param url - Feature service url.
+ * @param updates - Array of JSON features to update.
+ * @param params - Query parameters to be sent to the feature service via the request.
+ */
+export interface IUpdateFeaturesRequestOptions
+  extends IEditFeaturesParams,
+    IRequestOptions {
+  /**
+   * Feature service url.
+   */
+  url: string;
+  /**
+   * Array of JSON features to update.
+   */
+  updates: IFeature[];
+}
+
+/**
+ * Update features results.
+ */
+export interface IUpdateFeaturesResult {
+  /**
+   * Array of JSON response Object(s) for each feature updated.
+   */
+  updateResults?: IEditFeatureResult[];
+}
+
+/**
+ * Update features request. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/update-features.htm) for more information.
+ *
+ * ```js
+ * import { updateFeatures } from '@esri/arcgis-rest-feature-service';
+ *
+ * const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0";
+ *
+ * updateFeatures({
+ *   url,
+ *   updates: [{
+ *     geometry: { x: -120, y: 45, spatialReference: { wkid: 4326 } },
+ *     attributes: { status: "alive" }
+ *   }]
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the updateFeatures response.
+ */
+export function updateFeatures(
+  requestOptions: IUpdateFeaturesRequestOptions
+): Promise<IUpdateFeaturesResult> {
+  const url = `${requestOptions.url}/updateFeatures`;
+
+  // edit operations are POST only
+  const options: IUpdateFeaturesRequestOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  appendCustomParams(requestOptions, options);
+
+  // mixin, don't overwrite
+  options.params.features = requestOptions.updates;
+  delete options.params.updates;
+
+  return request(url, options);
+}

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

@@ -0,0 +1,74 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import { request, IRequestOptions } from "@esri/arcgis-rest-request";
+
+import { 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;
+  /**
+   * Unique identifier of feature to update related attachment.
+   */
+  featureId: number;
+  /**
+   * File to be updated.
+   */
+  attachment: File;
+  /**
+   * Unique identifier of the attachment.
+   */
+  attachmentId: number;
+}
+
+/**
+ * `updateAttachment()` request response.
+ */
+export interface IUpdateAttachmentResponse {
+  /**
+   * Standard AGS add/update/edit result Object for the attachment.
+   */
+  updateAttachmentResult: IEditFeatureResult;
+}
+
+/**
+ * Update a related attachment to a feature by id. See [Update Attachment](https://developers.arcgis.com/rest/services-reference/update-attachment.htm) for more information.
+ *
+ * ```js
+ * import { updateAttachment } from '@esri/arcgis-rest-feature-service';
+ *
+ * updateAttachment({
+ *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/ServiceRequest/FeatureServer/0",
+ *   featureId: 8484,
+ *   attachment: myFileInput.files[0],
+ *   attachmentId: 306
+ * });
+ * ```
+ *
+ * @param requestOptions - Options for the request.
+ * @returns A Promise that will resolve with the `updateAttachment()` response.
+ */
+export function updateAttachment(
+  requestOptions: IUpdateAttachmentOptions
+): Promise<IUpdateAttachmentResponse> {
+  const options: IUpdateAttachmentOptions = {
+    params: {},
+    ...requestOptions
+  };
+
+  // `attachment` and `attachmentId` --> params: {}
+  options.params.attachment = requestOptions.attachment;
+  options.params.attachmentId = requestOptions.attachmentId;
+
+  return request(
+    `${options.url}/${options.featureId}/updateAttachment`,
+    options
+  );
+}

package/packages/arcgis-rest-feature-service/test/attachments.test.ts

@@ -0,0 +1,203 @@
+/* Copyright (c) 2018 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+
+import * as fetchMock from "fetch-mock";
+
+import {
+  getAttachments,
+  IGetAttachmentsOptions,
+  addAttachment,
+  IAddAttachmentOptions,
+  updateAttachment,
+  IUpdateAttachmentOptions,
+  deleteAttachments,
+  IDeleteAttachmentsOptions
+} from "../src/index";
+
+import {
+  getAttachmentsResponse,
+  addAttachmentResponse,
+  updateAttachmentResponse,
+  deleteAttachmentsResponse,
+  genericInvalidResponse
+} from "./mocks/feature";
+
+export function attachmentFile() {
+  if (typeof File !== "undefined" && File) {
+    return new File(["foo"], "foo.txt", { type: "text/plain" });
+  } else {
+    const fs = require("fs");
+    return fs.createReadStream(
+      "./packages/arcgis-rest-feature-service/test/mocks/foo.txt"
+    );
+  }
+}
+
+const serviceUrl =
+  "https://services.arcgis.com/f8b/arcgis/rest/services/Custom/FeatureServer/0";
+
+describe("attachment methods", () => {
+  afterEach(fetchMock.restore);
+
+  it("should return an array of attachmentInfos for a feature by id", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      params: {
+        gdbVersion: "SDE.DEFAULT"
+      },
+      httpMethod: "GET"
+    } as IGetAttachmentsOptions;
+    fetchMock.once("*", getAttachmentsResponse);
+    getAttachments(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${
+            requestOptions.featureId
+          }/attachments?f=json&gdbVersion=SDE.DEFAULT`
+        );
+        expect(options.method).toBe("GET");
+        expect(getAttachmentsResponse.attachmentInfos.length).toEqual(2);
+        expect(getAttachmentsResponse.attachmentInfos[0].id).toEqual(409);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the added attachment and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IAddAttachmentOptions;
+    fetchMock.once("*", addAttachmentResponse);
+    addAttachment(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/addAttachment`
+        );
+        expect(options.method).toBe("POST");
+
+        const params = options.body as FormData;
+        expect(params instanceof FormData).toBeTruthy();
+        // we can introspect FormData in Chrome this way, but not Node.js
+        // more info: https://github.com/form-data/form-data/issues/124
+        if (params.get) {
+          expect(params.get("returnEditMoment")).toEqual("true");
+        }
+        expect(addAttachmentResponse.addAttachmentResult.objectId).toEqual(
+          1001
+        );
+        expect(addAttachmentResponse.addAttachmentResult.success).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return an error for a service/feature which does not have attachments", done => {
+    const requestOptions = {
+      url:
+        "https://services.arcgis.com/f8b/arcgis/rest/services/NoAttachments/FeatureServer/0",
+      featureId: 654,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IAddAttachmentOptions;
+    fetchMock.once("*", genericInvalidResponse);
+    addAttachment(requestOptions)
+      .then(() => {
+        // nothing to test here forcing error
+        fail();
+      })
+      .catch(error => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/addAttachment`
+        );
+        expect(options.method).toBe("POST");
+        expect(error.response.error.code).toEqual(400);
+        expect(error.response.error.message).toEqual(
+          "Invalid or missing input parameters."
+        );
+        done();
+      });
+  });
+
+  it("should return objectId of the updated attachment and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachmentId: 1001,
+      attachment: attachmentFile(),
+      params: {
+        returnEditMoment: true
+      }
+    } as IUpdateAttachmentOptions;
+    fetchMock.once("*", updateAttachmentResponse);
+    updateAttachment(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/updateAttachment`
+        );
+        expect(options.method).toBe("POST");
+        expect(
+          updateAttachmentResponse.updateAttachmentResult.objectId
+        ).toEqual(1001);
+        expect(updateAttachmentResponse.updateAttachmentResult.success).toEqual(
+          true
+        );
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+
+  it("should return objectId of the deleted attachment and a truthy success", done => {
+    const requestOptions = {
+      url: serviceUrl,
+      featureId: 42,
+      attachmentIds: [1001],
+      params: {
+        returnEditMoment: true
+      }
+    } as IDeleteAttachmentsOptions;
+    fetchMock.once("*", deleteAttachmentsResponse);
+    deleteAttachments(requestOptions)
+      .then(() => {
+        expect(fetchMock.called()).toBeTruthy();
+        const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+        expect(url).toEqual(
+          `${requestOptions.url}/${requestOptions.featureId}/deleteAttachments`
+        );
+        expect(options.body).toContain("attachmentIds=1001");
+        expect(options.body).toContain("returnEditMoment=true");
+        expect(options.method).toBe("POST");
+        expect(
+          deleteAttachmentsResponse.deleteAttachmentResults[0].objectId
+        ).toEqual(1001);
+        expect(
+          deleteAttachmentsResponse.deleteAttachmentResults[0].success
+        ).toEqual(true);
+        done();
+      })
+      .catch(e => {
+        fail(e);
+      });
+  });
+});